Functional course with secured mocks

Summary

Quickstart

First, you can download the Postman collection example here.

Don't forget to update collections variables (in the "Variables" tab) with client_id and client_secret provided by Bouygues Telecom. Others variables will be updated automatically when runing this collection.

Requirements

  • Postman
  • client_id an client_secret provided by Bouygues Telecom.

Introduction

The mocks are available on the staging environment.

The purpose of these mocks is to provide a consistent API Functional journey that is continuously usable. Each mock also offers error responses to enable the testing of all possible combinations of calls to these APIs. Security for the call to these mocks is done with OAuth2 (Authorization Type: Bearer Token).

Mocks URL Security Flow
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/email-addresses/check APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/portabilities/check-eligibility APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/ibans/check APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/postal-addresses/normalization APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/customer-accounts APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/product-ordering/orders APP CREDENTIAL FLOW
https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/product-ordering/shopping-carts USER LOGIN FLOW

List of values to use for the successful test case

API Value (payload)
CheckEmailAddress {
   "emailAddress": "openapicustomer.ap4@gmail.com"
}
NormalizePostalAddress {
   "additionalInformation": "appartement 114",
 "locality": "TRAPPES",
 "postCode": "78190",
 "postOfficeBox": "",
   "streetName": "place de la paix",
 "streetNumber": "1",
 "valSuggestion": ""
}
CheckEligibility {
 "phoneNumber": "+33639980515",
 "rioCode": "57P112345CCQ"
}
CheckIban {
 "iban": "FR7630001007941234567890185"
}
CreateCustomerAccount {
 "birthDate": "1984-06-17",
 "birthDepartment": "92",
 "emailAddress": "openapicustomer.ap4@gmail.com",
 "firstName": "New",
 "lastName": "User",
 "phoneNumber": "+33639980515",
 "title": "MME"
}
CreateShoppingCart {
 "scheme": [
  {
  "products": [
   {
    "id": "6606"
   }
  ],
  "childrenOnlineProtection": true,
  "rioCode": "57P112345CCQ",
  "carryPhoneNumber": "0639980515",
  "autoEnabledSimCard": true
  }
 ],
 "billingAddress": {
  "additionalInformation": "appartement 114",
  "locality": "TRAPPES",
  "postCode": "78190",
  "streetName": "place de la paix",
  "streetNumber": "1"
 },
 "iban": "FR7630001007941234567890185",
 "marketingCommunicationConsent": true,
 "shippingAddress": {
  "additionalInformation": "appartement 114",
  "firstName": "New",
  "lastName": "User",
  "locality": "TRAPPES",
  "postCode": "78190",
  "streetName": "place de la paix",
  "streetNumber": "1",
  "title": "MME"
 },
 "shippingOfferType": "LA_POSTE"
}
CreateOrder {
 "fingerPrint": "3851273939",
 "shoppingCartId": "{{shoppingCartId}}1",
 "uuid": "4942091b-3509-4951-945d-2afc3448bd48"
}

Authentication: Retrieving the URLs for authentication on the test bench

OAuth2 API - openid-configuration

Example of a call with CURL
curl --location 'https://oauth2.sandbox.bouyguestelecom.fr/ap4/.well-known/openid-configuration'
Response
200 OK
Content-Type: application/json
{
 "issuer":"https://oauth2.sandbox.bouyguestelecom.fr/ap4",
 "authorization_endpoint":"https://oauth2.sandbox.bouyguestelecom.fr/ap4/authorize",
 "token_endpoint":"https://oauth2.sandbox.bouyguestelecom.fr/ap4/token",
 "userinfo_endpoint":"https://oauth2.sandbox.bouyguestelecom.fr/ap4/userinfo",
 "revocation_endpoint":"https://oauth2.sandbox.bouyguestelecom.fr/ap4/revoke",
 "jwks_uri":"https://oauth2.sandbox.bouyguestelecom.fr/ap4/jwks.json",
 "end_session_endpoint":"https://www.mon-compte.sandbox.bouyguestelecom.fr/ap4/cas/logout",
 "response_types_supported":[
  "code",
  "id_token",
  "code id_token",
  "token id_token",
  "token"
 ],
 "response_modes_supported":[
  "query",
  "fragment"
 ],
 "subject_types_supported":[
  "public"
 ],
 "id_token_signing_alg_values_supported":[
  "RS256"
 ],
 "scopes_supported":[
  "openid",
  "profile",
  "email",
  "identifiers",
  "roles"
 ],
 "claims_supported":[
  "sub",
  "aud",
  "iss",
  "iat",
  "auth_time",
  "exp",
  "login",
  "name",
  "family_name",
  "given_name",
  "email",
  "user_type",
  "login_type",
  "roles"
 ]
}

URL values to retrieve for the following calls :

  • token_endpoint
  • authorization_endpoint

Authentication: Retrieving the token from partner credentials (APP CREDENTIALS FLOW)

API OAuth2 - /token

Call parameters

grant_type = client_credentials (x-www-form-urlencoded)

Authorization : Basic Auth with client_id and client_secret (headers)

Example of a call with CURL
curl --location 'https://oauth2.sandbox.bouyguestelecom.fr/ap4/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Authorization: Basic {basic token (client_id:client_secret base64 encoded)}' \
--data-urlencode 'grant_type=client_credentials'
Response
200 OK
Content-Type: application/json
{
    "access_token": "at-2d574357-b65e-474e-82b8-f3bf75afb1d4",
    "expires_in": 3600,
    "token_type": "Bearer",
    "refresh_credit": 0,
    "scope": "EXT_PostalAddressConsult EXT_SalesPartnerContext EXT_ShoppingCartManage openid EXT_IbanConsult roles profile DocumentConsult EXT_CustomerAccountManage EXT_EmailAddressConsult EXT_PortabilityConsult EXT_OrderManage"
}

You need to retrieve the access token for the following calls. It will then be used in the Authorization header as a Bearer token.

Functional journey : CheckEmailAddress API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/email-addresses/check' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
    "emailAddress": "openapicustomer.ap4@gmail.com"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the APP CREDENTIALS FLOW

Correlation between payload and response

Payload

{
    "emailAddress": "openapicustomer.ap4@gmail.com"
}

Return code and response

200 OK
{
  "contactEmailAddress": true,
  "validEmailAddress": true
}

Payload

{
    "emailAddress": "test@bytel.fr"
}

Return code and response

200 OK
{
  "contactEmailAddress": true,
  "validEmailAddress": true
}

Payload

{
    "emailAddress": "test2@bytel.fr"
}

Return code and response

200 OK
{
  "contactEmailAddress": false,
  "validEmailAddress": true
}

Payload

{
    "emailAddress": "test^@bytel.fr"
}

Return code and response

200 OK
{
  "contactEmailAddress": false,
  "validEmailAddress": false
}

Payload

{
    "emailAddress": " test@bytel.fr"
}

Return code and response

400 BAD REQUEST
{
  "error": "BAD_REQUEST",
  "error_description": "",
  "error_uri": "",
  "error_parameters": [
    ""
  ]
}

Functional journey : NormalizePostalAddress API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/postal-addresses/normalization' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "postOfficeBox": "",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "valSuggestion": ""
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the APP CREDENTIALS FLOW

Correlation between payload and response
The mock handles 13 use cases depending on the parameters passed in the message body : additionalInformation locality postCode postOfficeBox streetName streetNumber valSuggestion response
appartement 114 TRAPPES 78190 place de la paix 1 response 1
35650 ajoncs 8 response 2
35650 ajoncs 8 015300--------00000095---------------------23811C** response 3
paris 75006 vaugirard 500 response 4
paris 75006 vaugirard 500 012559--------00007100N0348004096----------03357S response 5
technopole meudon-la-foret 92360 avenue du maréchal juin 13-15 response 6
LENS 62300 avenue de varsovie 54 response 7
r'lyeh 35000 rue du poulpe rieur 1 response 8
35999 place de bretagne 4 response 9
NANTES CEDEX 2 44000 BP36388 response 10
paris 75015 rue vaugirard 500 response 11
A 1 A A A response 12
APPARTEMENT 26 GRANVILLE 50400 route HLM LE HETRE 0 response 13

Return code and response 1

200 OK
{
  "normalizedPostalAddress": {
    "hexacleNumber": "78621229HX",
    "hexacleStreet": "78621229E9",
    "hexavia": "03803036",
    "locality": "TRAPPES",
    "localityInseeCode": "78621",
    "postCode": "78190",
    "streetName": "PLACE DE LA PAIX",
    "streetNumber": "1"
  }
}

Return code and response 2

200 OK
{
  "suggestedLocalities": [
    {
      "coincidence": 95,
      "inseeCode": "35240",
      "locality": "LE RHEU",
      "maxPostCode": "35659",
      "minPostCode": "35650",
      "suggestedDispatchLocality": "LE RHEU",
      "suggestionNumber": 0,
      "valSuggestion": "015299--------00000095---------------------23811C**"
    },
    {
      "coincidence": 95,
      "inseeCode": "35910",
      "locality": "MOIGNE",
      "maxPostCode": "35650",
      "minPostCode": "35650",
      "suggestedDispatchLocality": "LE RHEU",
      "suggestionNumber": 1,
      "valSuggestion": "015300--------00000095---------------------23811C**"
    }
  ]
}

Return code and response 3

200 OK
{
  "normalizedPostalAddress": {
    "hexacleNumber": "35240223GU",
    "hexacleStreet": "35240222AA",
    "hexavia": "00675226",
    "locality": "LE RHEU",
    "localityInseeCode": "35240",
    "postCode": "35650",
    "streetName": "RUE DES AJONCS",
    "streetNumber": "8"
  }
}

Return code and response 4

200 OK
{
  "suggestedStreetNames": [
    {
      "coincidence": 96,
      "locality": "PARIS",
      "postCode": "75006",
      "streetName": "RUE DE VAUGIRARD",
      "suggestionNumber": 0,
      "valSuggestion": "012559--------00007100J00000---------------03357*S*"
    },
    {
      "coincidence": 96,
      "locality": "PARIS",
      "postCode": "75015",
      "streetName": "RUE DE VAUGIRARD",
      "suggestionNumber": 1,
      "valSuggestion": "012559--------00007100J00001---------------03357*S*"
    },
    {
      "coincidence": 96,
      "locality": "PARIS",
      "postCode": "75015",
      "streetName": "BOULEVARD DE VAUGIRARD",
      "suggestionNumber": 2,
      "valSuggestion": "012559--------00007100N0348004096----------03357*S*"
    }
  ]
}

Return code and response 5

200 OK
{
  "normalizedPostalAddress": {
    "hexacleStreet": "75115222MH",
    "hexavia": "01456466",
    "locality": "PARIS",
    "localityInseeCode": "75115",
    "postCode": "75015",
    "streetName": "BOULEVARD DE VAUGIRARD",
    "streetNumber": "500"
  },
  "warning": [
    "MISSING_HEXACLE_NUMBER"
  ]
}

Return code and response 6

200 OK
{
  "normalizedPostalAddress": {
    "hexacleNumber": "9204822BAV",
    "hexacleStreet": "92048222HI",
    "hexavia": "01750446",
    "locality": "MEUDON",
    "localityInseeCode": "92048",
    "postCode": "92360",
    "streetName": "AVENUE DU MARECHAL JUIN",
    "streetNumber": "13"
  },
  "warning": [
    "UNRECOGNIZABLE_ITEM"
  ]
}

Return code and response 7

200 OK
{
  "normalizedPostalAddress": {
    "hexacleStreet": "624982222M",
    "hexavia": "01238211",
    "locality": "LENS",
    "localityInseeCode": "62498",
    "postCode": "62300",
    "streetName": "AVENUE DE VARSOVIE",
    "streetNumber": "54"
  },
  "warning": [
    "MISSING_HEXACLE_NUMBER"
  ]
}

Return code and response 8

400 BAD REQUEST
{
  "error": "INVALID_LOCALITY",
  "error_description": "La localité n’existe pas"
}

Return code and response 9

400 BAD REQUEST
{
  "error": "INVALID_POST_CODE",
  "error_description": "Le code postal n’existe pas"
}

Return code and response 10

400 BAD REQUEST
{
  "error": "INVALID_STREET_NAME",
  "error_description": "La voie n’existe pas"
}

Return code and response 11

400 BAD REQUEST
{
  "error": "OUT_OF_BOUNDS_STREET_NUMBER",
  "error_description": "L’adresse ne peut pas être validée car Uniserv propose une liste de secteurs de numéros"
}

Return code and response 12

500

Return code and response 13

200 OK
{
  "normalizedPostalAddress": {
    "hexacleStreet": "502182224X",
    "hexavia": "00994797",
    "locality": "GRANVILLE",
    "localityInseeCode": "50218",
    "postCode": "50400",
    "streetName": "HLM LE HETRE"
  },
  "warning": [
    "MISSING_STREET_NUMBER",
    "MISSING_HEXACLE_NUMBER"
  ]
}

Functional journey : CheckEligibility API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/portabilities/check-eligibility' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
    "phoneNumber": "+33639980515",
    "rioCode": "57P112345CCQ"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the APP CREDENTIALS FLOW

Correlation between payload and response
The mock handles 4 use cases depending on the phone number and RIO code passed in the message body : phoneNumber rioCode response
+33639980515 57P112345CCQ response 1
+33639980525 03P1123455LO response 2
+33639980535 01P112397+QS response 3
0639980545 07P112345ANX response 4

Return code and response 1

200 OK
{
    "eligibleForPortability": true
}

Return code and response 2

200 OK
{
    "eligibleForPortability": false,
    "ineligibilityMessage": "UNAUTHORIZED_PORTABILITY_REQUEST"
}

Return code and response 3

200 OK
{
    "eligibleForPortability": false,
    "ineligibilityMessage": "IN_PROGRESS_PORTABILITY_REQUEST"
}

Return code and response 4

400 BAD REQUEST
{
    "error": "INVALID_FORMAT",
    "error_description": "Le format des champs phoneNumber est incorrect."
}

Functional journey : CheckIban API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/ibans/check' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
    "iban": "FR7630001007941234567890185"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

Correlation between payload and response
The mock handles 3 use cases according to the IBAN passed in the body of the message: iban response
FR7603561016000000000000026 response 2
FR7610207000010452222222269 response 3
FR7630001007941234567890185 response 1

Return code and response 1

204 No Content

Return code and response 2

200 OK
{
    "error": "INVALID_PARAMETER",
    "error_description": "iban[{0}] invalid",
    "error_parameters": [
        "FR7603561016000000000000026"
    ]
}

Return code and response 3

200 OK
{
    "error": "BANK_ACCOUNT_TYPE_NOT_ALLOWED",
    "error_description": "iban[{0}] not allowed",
    "error_parameters": [
        "FR7610207000010452222222269"
    ]
}

Functional journey : CreateCustomerAccount API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/customer-management/customer-accounts' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
  "birthDate": "1984-06-17",
  "birthDepartment": "92",
  "emailAddress": "openapicustomer.ap4@gmail.com",
  "firstName": "New",
  "lastName": "User",
  "phoneNumber": "+33639980515",
  "title": "MME"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the APP CREDENTIALS FLOW

Correlation between payload and response

The mock handles 2 uses cases : Payload :

{
  "birthDate": "1984-06-17",
  "birthDepartment": "92",
  "emailAddress": "openapicustomer.ap4@gmail.com",
  "firstName": "New",
  "lastName": "User",
  "phoneNumber": "+33639980515",
  "title": "MME"
}

Return code and response

204 No Content

Payload :

{
  "birthDate": "1984-06-17",
  "birthDepartment": "92",
  "emailAddress": "test@bytel.fr",
  "firstName": "New",
  "lastName": "User",
  "phoneNumber": "+33656279217",
  "title": "MME"
}

Return code and response

204 No Content

Authentication : Retrieving an authorization code (USER LOGIN FLOW)

OAuth2 API - /authorize with your callback URL

Alternative using Postman further below

Example of a call
https://oauth2.sandbox.bouyguestelecom.fr/ap4/authorize?client_id={client_id}&response_type=code&redirect_uri={callback_url}

The simplest way is to put this URL into your browser after modifying the parameters (your client_id and your callback URL)

Response

With à browser, we move on to the Bouygues Telecom authentication screen (next step).

Authentication : Bouygues Telecom authentication screen

Alternative using Postman further below

The client USER and PASSWORD must be provided. You should use the USER & PASSWORD examples provided by Bouygues Telecom.

Then, the authorization_code is sent back to the callback URL. If the callback URL is not valid, the browser will time out and the authorization code will be found in the URL. Ex: 

https://fake-url.com/callback?code=ac-f55d6bf5-ba99-44ce-bc48-09cffd268172

Authentication : Retrieving token (USER LOGIN FLOW)

OAuth2 API - /token

Alternative using Postman further below

Call parameters

grant_type = authorization_code (x-www-form-urlencoded)

redirect_uri = Callback URL (x-www-form-urlencoded)

code = {authorization_code} (x-www-form-urlencoded)

Authorization : Basic Auth with client_id and client_secret (headers)

Example of a call with CURL
curl --location 'https://oauth2.sandbox.bouyguestelecom.fr/ap4/token' \
--header 'Authorization: Basic {basic token (client_id:client_secret base64 encoded)}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'redirect_uri=https://fake-url.com/callback' \
--data-urlencode 'code=ac-c53cad15-a546-4d1f-a7f0-068205d0345e'
Response
200 OK
{
    "access_token": "at-24edb479-8d56-438e-b661-1bd116e441b8",
    "expires_in": 3600,
    "token_type": "Bearer",
    "refresh_credit": 0,
    "scope": "EXT_PostalAddressConsult EXT_SalesPartnerContext EXT_ShoppingCartManage openid EXT_IbanConsult roles profile DocumentConsult EXT_EmailAddressConsult EXT_CustomerAccountManage EXT_PortabilityConsult EXT_OrderManage",
    "id_token": "eyJraWQiOiJieXRlbGp3a3N0YmR2NiIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2IiwiandrIjp7Imt0eSI6IlJTQSIsImUiOiJBUUFCIiwibiI6InVNY2pHNDF2RTJ6d2hEZXFzMkMyTjZreW1SMWtpdC15R2R1Ym5CTU1FV1BBcHZqUGVMMWFEOFJVWjNZZTVlWDQzd0Q1aG1CWmduUzFIVUpidC1NMXlGalExMkktal8wQ3pUblNWeENKV1hWZ3U4UWVHcEotNU85blhBRTBTR2VPZ2VqLV84Ujk2cXZEYjB4c09TcWVYbktmQjNvSVY3SE5MVDFZNC1JWEJTZzY0NDM0TmJCQ01VZ1lmOXBmQTIxQWZVS2VaOHRzNWpOR0dxaV9jREVQcUxFelpaR3ZmYlJtRVo5QXdpLW9XVlFmUWd0c2QtRTNtSGlhd1pBZk1JVmNZaHlhN215TTZDRE5VVEFWd25oQlhmYTNSQUZzQ0kzMms2TXUwNlRpTXRlTzZkaFFzOThYeHJDN09VdVFGNjBCdFFxM3I5djJPNEFlRUFhQ0dFMVgwUSJ9fQ.eyJhdF9oYXNoIjoiUGVZTkE4VzdYbDYzUDQzUWI3YWxwQT09Iiwic3ViIjoiNGFhOTRlZmY0NWE4Mzg1M2E2ZGMzNjg0YzQ1MzZlMDgxODUxNzBlNzBlYjJiYjQxZWQ1NGNkMDk4NzgzNzUwOSIsImxvZ2luX3R5cGUiOiJNU0lTRE4iLCJhbXIiOlsicHdkIiwib3RwIl0sInJvbGVzIjpbIkNMSUVOVF9TUCJdLCJpc3MiOiJodHRwczpcL1wvb2F1dGgyLnNhbmRib3guYm91eWd1ZXN0ZWxlY29tLmZyXC9hcDQiLCJnaXZlbl9uYW1lIjoiVFJUTVFXIiwiZGV2aWNlSWQiOiJJbmNvbm51IiwiYXVkIjpbIk9BVVRIMiIsImJ5dGVsLXNhbXN1bmctY29tIl0sImFjciI6InVybjpib3V5Z3Vlc3RlbGVjb206YWNyOmNsYXNzZXM6bW9kZXJhdGUiLCJjX2hhc2giOiJVRnpUb1NHYkVtZW1ZVVdiRngrUlFnPT0iLCJ1c2VyX3R5cGUiOiJDTElFTlQiLCJhenAiOiJieXRlbC1zYW1zdW5nLWNvbSIsImF1dGhfdGltZSI6MTcxMjU3OTU0MiwibmFtZSI6IlRydG1xdyBSb2JpZGVvc21hc3VsIiwidGFyZ2V0X2lkZW50aXR5IjpmYWxzZSwicGFydG5lcklkIjoiNmVlZWM2ZDMtMzgzOS00OGVlLWIzZjgtNWFkYzI0ZWQ3NTljIiwiZXhwIjoxNzEyNTgzNDIyLCJpYXQiOjE3MTI1Nzk4MjIsImZhbWlseV9uYW1lIjoiUk9CSURFT1NNQVNVTCIsImp0aSI6Imp0aS0xZjIzNTA0YS01ZmJkLTQ3YTEtYjhhYy00ZDYwZmY0NWZiZjIifQ.NMCZvroQ0Gxm3v7FmhG_mprwsvk24s_T_MyIwdNaAAqtarJd9KiY5-Kxs9p1SX5R6G-umXF_I1UQZXqlOaYMW50o3oFZHc-lrrNxBHWQpYbVqksOg-H6_bQpNNKtz21byjeUEm72zE89mFzaIodQAp2ZQV512S2VO3Bqxp0JHT_F-OzApUnOdqwDx6n6epxkbrlHtW3j53jlwzCt3xYtOtG59KGJeKORF08ws2mmkiV6JWWZ9o4-noHlwJD9lMosl6sptWwNGuq_tKIUVnISgfvP9QVRP0kYu2J5rRXV_Fydqm9KtI3FDiHSggnyjabBjcwK7xyC_WK0_BMxbrU-Kg"
}

Functional journey : CreateShoppingCart API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/product-ordering/shopping-carts' \
--header 'Authorization: Bearer at-24edb479-8d56-438e-b661-1bd116e441b8' \
--header 'Content-Type: application/json' \
--data '{
    "scheme": [
        {
            "products": [
                {
                    "id": "6606"
                }
            ],
            "childrenOnlineProtection": true,
            "rioCode": "57P112345CCQ",
            "carryPhoneNumber": "0639980515",
            "autoEnabledSimCard": true
        }
    ],
    "billingAddress": {
        "additionalInformation": "appartement 114",
        "locality": "TRAPPES",
        "postCode": "78190",
        "streetName": "place de la paix",
        "streetNumber": "1"
    },
    "iban": "FR7630001007941234567890185",
    "marketingCommunicationConsent": true,
    "shippingAddress": {
        "additionalInformation": "appartement 114",
        "firstName": "Sonia",
        "lastName": "GUEDES",
        "locality": "TRAPPES",
        "postCode": "78190",
        "streetName": "place de la paix",
        "streetNumber": "1",
        "title": "MME"
    },
    "shippingOfferType": "LA_POSTE"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the USER LOGIN FLOW

Alternatively, use the built-in 'Auth' feature in Postman.

You can perform all of these actions (retrieval of the authorization code, authentication screen, and token acquisition) by utilizing the integrated 'Auth' feature of Postman.

  1. Start a browser in private mode
  2. In the 'Auth' tab of Postman, configured as follows :
    • Type : OAuth 2.0
    • Add auth data to : Request Headers
    • Current Token - Token : user-flow-token
    • Current Token - Use Token Type : Access Token
    • Current Token - Header Prefix : Bearer
    • Configure New Token - Token name : user-flow-token
    • Configure New Token - Grant type : Authorization Code
    • Configure New Token - Callback URL : https://oauth.pstman.io/v1/callback
    • Configure New Token - Authorize using browser : YES
    • Configure New Token - Auth URL : use authorization_endpoint (step Authentication: Retrieving the URLs for authentication on the test bench)
    • Configure New Token - Access Token URL : use token_endpoint (step Authentication: Retrieving the URLs for authentication on the test bench)
    • Configure New Token - Client ID : use the client_id provided by Bouygues Telecom for your usage
    • Configure New Token - Client Secret : use the client_secret provided by Bouygues Telecom for your usage
    • Configure New Token - Client Authentication : Send as Basic Auth Header
  3. Click on "Clear cookies" at the bottom of the Auth page
  4. Click on "Get New Acces Token" at the bottom of the Auth page.
  5. In the browser, you will be able to log in using the USER and PASSWORD examples provided by Bouygues Telecom (be aware that you might need to disable blocked pop-ups).
  6. After authentication, the token will be available in Postman. A pop-up will open, you simply have to select "Use Token"
  7. Then, you can call the CreateShoppingCart API in Postman
Correlation between payload and response

The mock handles 7 uses cases :

Payload 1


{
  "scheme": [
    {
      "products": [
        {
          "id": "6606"
        }
      ],
      "childrenOnlineProtection": true,
      "rioCode": "57P112345CCQ",
      "carryPhoneNumber": "0639980515",
      "autoEnabledSimCard": true
    }
  ],
  "billingAddress": {
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1"
  },
  "iban": "FR7630001007941234567890185",
  "marketingCommunicationConsent": true,
  "shippingAddress": {
    "additionalInformation": "appartement 114",
    "firstName": "New",
    "lastName": "User",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "title": "MME"
  },
  "shippingOfferType": "LA_POSTE"
}

Response 1

201
{
  "shoppingCartId": "{generated id}"
}

Payload 2

{
    "scheme": [
        {
            "products": [
                {
                    "id": "6606"
                }
            ],
            "childrenOnlineProtection": true,
            "rioCode": "05P1111112X5",
            "carryPhoneNumber": "0648992833",
            "autoEnabledSimCard": true
        }
    ],
    "billingAddress": {
        "additionalInformation": "batimenta",
        "locality": "Marlyleroi",
        "postCode": "78160",
        "streetName": "squaredemontecristo",
        "streetNumber": "2"
    },
    "iban": "FR7630004001522017140463766",
    "marketingCommunicationConsent": true,
    "shippingAddress": {
        "additionalInformation": "batimenta",
        "firstName": "Sonia",
        "lastName": "GUEDES",
        "locality": "Marlyleroi",
        "postCode": "78160",
        "streetName": "squaredemontecristo",
        "streetNumber": "8",
        "title": "MME"
    },
    "shippingOfferType": "LA_POSTE"
}

Response 2

201
{
  "shoppingCartId": "{generated id}"
}

Payload 3

{
  "scheme": [
    {
      "products": [
        {
          "id": "6606"
        }
      ],
      "childrenOnlineProtection": true,
      "autoEnabledSimCard": true
    }
  ],
  "billingAddress": {
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1"
  },
  "iban": "FR7630001007941234567890185",
  "marketingCommunicationConsent": true,
  "shippingAddress": {
    "additionalInformation": "appartement 114",
    "firstName": "Sonia",
    "lastName": "GUEDES",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "title": "MME"
  },
  "shippingOfferType": "LA_POSTE"
}

Response 3

201
{
  "shoppingCartId": "{generated id}"
}

Payload 4

{
  "scheme": [
    {
      "products": [
        {
          "id": "6606"
        }
      ],
      "childrenOnlineProtection": true,
      "rioCode": "57P112345CCQ",
      "carryPhoneNumber": "0639980515",
      "autoEnabledSimCard": true
    }
  ]
}

Response 4

400 BAD REQUEST
{
  "error": "HTTP_BAD_REQUEST",
  "error_description": "HTTP_BAD_REQUEST"
}

Payload 5

{
  "scheme": [
    {
      "products": [
        {
          "id": "6606"
        }
      ],
      "childrenOnlineProtection": true,
      "rioCode": "57P112345CCQ",
      "carryPhoneNumber": "0639980515",
      "autoEnabledSimCard": true
    }
  ],
  "billingAddress": {
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1"
  },
  "iban": "FR7630001007941234567890185",
  "marketingCommunicationConsent": true,
  "shippingAddress": {
    "additionalInformation": "appartement 114",
    "firstName": "",
    "lastName": "GUEDES",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "title": "MME"
  },
  "shippingOfferType": "LA_POSTE"
}

Response 5

400 BAD REQUEST
{
  "error": "CUSTOMER_DETAILS_CHECK_FAILED",
  "error_description": "CUSTOMER_DETAILS_CHECK_FAILED"
}

Payload 6

{
  "scheme": [
    {
      "products": [
        {
          "id": "9999"
        }
      ],
      "childrenOnlineProtection": true,
      "rioCode": "57P112345CCQ",
      "carryPhoneNumber": "0639980515",
      "autoEnabledSimCard": true
    }
  ],
  "billingAddress": {
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1"
  },
  "iban": "FR7630001007941234567890185",
  "marketingCommunicationConsent": true,
  "shippingAddress": {
    "additionalInformation": "appartement 114",
    "firstName": "Sonia",
    "lastName": "GUEDES",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "title": "MME"
  },
  "shippingOfferType": "LA_POSTE"
}

Response 6

400 BAD REQUEST
{
  "error": "PARTNER_INFORMATION_CHECK_FAILED",
  "error_description": "PARTNER_INFORMATION_CHECK_FAILED"
}

Payload 7

{
  "scheme": [
    {
      "products": [
        {
          "id": "6606"
        }
      ],
      "childrenOnlineProtection": true,
      "rioCode": "57P112345CCQ",
      "carryPhoneNumber": "0639980515",
      "autoEnabledSimCard": true
    }
  ],
  "billingAddress": {
    "additionalInformation": "appartement 114",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1"
  },
  "iban": "FR7603561016000000000000026",
  "marketingCommunicationConsent": true,
  "shippingAddress": {
    "additionalInformation": "appartement 114",
    "firstName": "Sonia",
    "lastName": "GUEDES",
    "locality": "TRAPPES",
    "postCode": "78190",
    "streetName": "place de la paix",
    "streetNumber": "1",
    "title": "MME"
  },
  "shippingOfferType": "LA_POSTE"
}

Response 7

400 BAD REQUEST
{
  "error": "SCORING_CHECK_FAILED",
  "error_description": "SCORING_CHECK_FAILED"
}

Functional journey : CreateOrder API mock

Example of a call with CURL
curl --location 'https://open.api.sandbox.bouyguestelecom.fr:443/ap/trial/v1/product-ordering/orders' \
--header 'Authorization: Bearer at-2d574357-b65e-474e-82b8-f3bf75afb1d4' \
--header 'Content-Type: application/json' \
--data '{
    "fingerPrint": "3851273939",
    "shoppingCartId": "472939170",
    "uuid": "4942091b-3509-4951-945d-2afc3448bd48"
}'
Authorization header parameters

Authorization : Bearer {access_token} (headers)

--> access_token obtained from the APP CREDENTIALS FLOW

Correlation between payload and response

The mock handles 2 uses cases : Payload 1

{
  "fingerPrint": "3851273939",
  "shoppingCartId": "{btShoppingCartId}",
  "uuid": "4942091b-3509-4951-945d-2afc3448bd48"
}

--> btShoppingCartId is retrieved from the createShoppingCart call.

Response

201 OK

Payload 2

{
  "fingerPrint": "3851273939",
  "shoppingCartId": "{wrong-btShoppingCartId}",
  "uuid": "4942091b-3509-4951-945d-2afc3448bd48"
}

--> with an wrong btShoppingCartId.

Response

404 NOT_FOUND
{
  "error": "NOT_FOUND",
  "error_description": "string",
  "error_uri": "string",
  "error_parameters": [
    "string"
  ]
}

Documentation

News

Tutorials

Getting started

Contact

Get in touch
https://developer.bouyguestelecom.fr/contact

     
        © Copyright Bouygues Telecom 2023. All rights reserved.