{"info":{"_postman_id":"4a780746-db6d-48ca-bdd7-38d8a314a7c6","name":"Back Office","description":"<html><head></head><body><p>This API allows you to handle :</p>\n<ul>\n<li>SSO features</li>\n<li>Account management</li>\n<li>Presence management</li>\n</ul>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"6740351","collectionId":"4a780746-db6d-48ca-bdd7-38d8a314a7c6","publishedId":"SzKbMvRF","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-03-03T09:15:45.000Z"},"item":[{"name":"Resources","item":[{"name":"Accounts","item":[{"name":"Obtain master access token","event":[{"listen":"test","script":{"id":"3687fb02-708b-4d14-b028-18a0250a5897","exec":["const data = JSON.parse(responseBody);\r","\r","pm.environment.set(\"backOfficeMasterToken\", data.access_token);"],"type":"text/javascript"}}],"id":"76a36128-94a5-4c13-93d6-21a1ec2cc9b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n    \"client_id\": \"{{backOfficeMasterClientId}}\",\n    \"client_secret\": \"{{backOfficeMasterClientSecret}}\",\n    \"grant_type\": \"client_credentials\"\n}"},"url":"https://oauth.messengeo.net/token","description":"<p>This resource must be used to retrieve an access token in order to manage accounts on this API. This is a oAuth2 request using <code>client_credentials</code> grant type.</p>\n<h1 id=\"response\">Response</h1>\n<p>It will respond with a <code>200 Ok</code> if it succeed. Here's a response example :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"access_token\": \"...\",\n    \"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": \"basic\"\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["token"],"host":["oauth","messengeo","net"],"query":[],"variable":[]}},"response":[{"id":"c3b9498a-eb81-4158-aae6-59e67265377e","name":"On success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"client_id\": \"{{backOfficeMasterClientId}}\",\n\t\"client_secret\": \"{{backOfficeMasterClientSecret}}\",\n\t\"grant_type\": \"client_credentials\"\n}"},"url":"https://oauth.messengeo.net/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"access_token\": \"YOUR ACCOUNT ACCESS TOKEN HERE\",\n    \"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": \"basic\"\n}"}],"_postman_id":"76a36128-94a5-4c13-93d6-21a1ec2cc9b7"},{"name":"Create new account","event":[{"listen":"test","script":{"id":"bc46e0cf-a8be-4392-99df-38b6750a02bc","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"408a2e12-73d7-42e0-b4d7-e574f1cbacf3","exec":["const account_reference = 'ORG_1234';","","pm.environment.set(\"backOfficeAccountReference\", account_reference);"],"type":"text/javascript"}}],"id":"b4466d7d-1ba9-4d4a-9f25-b276df9940ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n    \"externalIdentifier\": \"{{backOfficeExternalIdentifier}}\",\n    \"locale\": \"fr_FR\",\n    \"name\": \"ORG [1234] Rennes\",\n    \"firstName\": \"Jean\",\n    \"lastName\": \"Michel\",\n    \"email\": \"jean.michel@acme.com\",\n    \"groups\": [\n        \"ORG_RENNES\"\n    ],\n    \"fields\": {\n        \"businessAddress1\": \"20 Avenue Jules Maniez\",\n        \"businessCity\": \"Rennes\"\n    },\n    \"offer\": \"MY_CUSTOM_OFFER\"\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts","description":"<p>This resource allows you to create a new account.</p>\n<h2 id=\"payload\">Payload</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data type</th>\n<th>Description</th>\n<th>Required ?</th>\n<th>Default value</th>\n<th>Possible value</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>externalIdentifier</td>\n<td><code>string(255)</code></td>\n<td>This field should be used to track an account reference from your existing system</td>\n<td>yes</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>locale</td>\n<td><code>string</code></td>\n<td>The locale of the given account</td>\n<td>no</td>\n<td><code>\"fr_FR\"</code></td>\n<td><code>\"fr_FR\"</code>, <code>\"en_GB\"</code>, <code>\"es_ES\"</code>, <code>\"es_CO\"</code></td>\n</tr>\n<tr>\n<td>name</td>\n<td><code>string(255)</code></td>\n<td>This field will be used to label your account</td>\n<td>yes</td>\n<td></td>\n<td></td>\n</tr>\n<tr>\n<td>firstName</td>\n<td><code>string(255)</code></td>\n<td>This field should be used if you want to customize the account's holder first name</td>\n<td>no</td>\n<td><code>null</code></td>\n<td></td>\n</tr>\n<tr>\n<td>lastName</td>\n<td><code>string(255)</code></td>\n<td>This field should be used if you want to customize the account's holder last name</td>\n<td>no</td>\n<td><code>null</code></td>\n<td></td>\n</tr>\n<tr>\n<td>email</td>\n<td><code>string(255)</code></td>\n<td>This field should be used if you want to customize the account's holder email</td>\n<td>no</td>\n<td><code>null</code></td>\n<td></td>\n</tr>\n<tr>\n<td>groups</td>\n<td><code>Array</code></td>\n<td>This field should be used to put the account into a logical group (affiliate's group). It will try to perform an upsert on each specified groups. <strong>The given groups must exists prior to adding account to them</strong></td>\n<td>no</td>\n<td><code>[]</code></td>\n<td></td>\n</tr>\n<tr>\n<td>fields</td>\n<td><code>JSON object</code></td>\n<td>This field should be used to initialize account's fields based on your Digitaleo's network's fields</td>\n<td>no</td>\n<td><code>null</code></td>\n<td></td>\n</tr>\n<tr>\n<td>timezone</td>\n<td><code>string</code></td>\n<td>This field should be used to specify a timezone (list of existing timezones)</td>\n<td>no</td>\n<td><code>Europe/Paris</code></td>\n<td>List of existing timezones from the tz database below</td>\n</tr>\n<tr>\n<td>dependsOn</td>\n<td><code>Array</code></td>\n<td>This field should be used to dispatch the account on an allowed list of secondary networks. <strong>The given networks must exists prior to dispatching account to them</strong></td>\n<td>no</td>\n<td><code>[]</code></td>\n<td>List of allowed secondary networks. Contact your customer success manager to get this list.</td>\n</tr>\n<tr>\n<td>offer</td>\n<td><code>string</code></td>\n<td>This field should be used to specify the offer that will be applied to the new account.</td>\n<td>no</td>\n<td></td>\n<td>Contact your customer success manager to get this list.</td>\n</tr>\n<tr>\n<td>emailSenders</td>\n<td>array of strings</td>\n<td>List of allowed sender email addresses. Each item must be a valid email. Pass null to clear, [] to empty the list. Each sender domain <strong>must be validated in advance by Digitaleo</strong>.</td>\n<td>no</td>\n<td>[]</td>\n<td>Contact your customer success manager to get the list of approved sender domains.</td>\n</tr>\n<tr>\n<td>defaultEmailSender</td>\n<td>string</td>\n<td>Default email sender name. Pass null to clear the value</td>\n<td>no</td>\n<td>null</td>\n<td></td>\n</tr>\n<tr>\n<td>defaultReplyTo</td>\n<td>string</td>\n<td>Default reply-to email address. Must be a valid email. Pass null to clear</td>\n<td>no</td>\n<td>null</td>\n<td></td>\n</tr>\n</tbody>\n</table>\n</div><p>List of existing timezones : <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a></p>\n<h3 id=\"important-note\">Important note</h3>\n<p>The update of the fields may be delayed due to an asynchronous process.</p>\n<h2 id=\"response\">Response</h2>\n<p>It will respond with a <code>204 No content</code> if it succeed. The <code>Location</code> header will contain the link to the entity.</p>\n","urlObject":{"protocol":"https","path":["back-office","v1","accounts"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"40d7c8e8-0f67-4ee0-936b-6931fdea3f13","name":"On success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"externalIdentifier\": \"{{backOfficeExternalIdentifier}}\",\n\t\"locale\": \"fr_FR\", \n\t\"name\": \"ORG [1234] Rennes\",\n\t\"firstName\": \"Jean\",\n\t\"lastName\": \"Michel\", \n\t\"email\": \"jean.michel@acme.com\",\n\t\"groups\": [\n\t\t\"ORG_RENNES\"\n\t],\n\t\"fields\": {\n\t\t\"businessAddress1\": \"20 Avenue Jules Maniez\",\n\t\t\"businessCity\": \"Rennes\"\n\t},\n    \"offer\": \"MY_CUSTOM_OFFER\"\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Content-Type","value":"application/json"},{"key":"Location","value":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"e233748f-7bf6-4c7e-b0b4-0e412c65e5a8","name":"On validation error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"externalIdentifier\": \"{{backOfficeAccountReference}}\",\n\t\"locale\": \"fr_FR\", \n\t\"firstName\": \"Jean a un très long prénom qui pousse cet API à renvoyer une erreur de validation du champs car la limite de ce dernier est de 255 caractères. De ce fait cet exemple montre comment notre API gère ce type de problème avec la réponse appropriée (body + headers).\",\n\t\"lastName\": \"Michel\", \n\t\"email\": \"jean.michel@acme.com\",\n\t\"groups\": [\n\t\t\"ORG_RENNES\",\n\t\t\"A group that does not exists\"\n\t],\n\t\"fields\": {\n\t\t\"businessAddress1\": \"20 Avenue Jules Maniez\",\n\t\t\"businessCity\": \"Rennes\"\n\t},\n    \"offer\": \"MY_CUSTOM_OFFER\"\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts"},"status":"Expectation Failed","code":417,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data failed to pass validation.\",\n\t\"errorCode\": \"INVALID_PARAMETERS\",\n\t\"messages\": [\n\t\t{\n\t\t\t\"field\": \"name\",\n\t\t\t\"errorCode\": \"INVALID_PARAMETER\",\n            \"message\": \"The name field is required.\",\n            \"details\": \"The name field is required.\"\n\t\t},\n\t\t\n\t\t{\n\t\t\t\"field\": \"firstName\",\n\t\t\t\"errorCode\": \"INVALID_PARAMETER\",\n            \"message\": \"The name must be 255 characters.\",\n            \"details\": \"The name must be 255 characters.\"\n\t\t},\n\t\t{\n\t\t\t\"field\": \"groups\",\n\t\t\t\"errorCode\": \"INVALID_PARAMETER\",\n\t\t\t\"message\": \"The group [A group that does not exists] does not exists\",\n\t\t\t\"details\": \"The group [A group that does not exists] does not exists\"\n\t\t}\n\t]\n}"}],"_postman_id":"b4466d7d-1ba9-4d4a-9f25-b276df9940ef"},{"name":"Show existing account","event":[{"listen":"test","script":{"id":"9a95b721-04bb-4340-b857-04c7951fd2cc","exec":[""],"type":"text/javascript"}}],"id":"e1b75ce8-0e60-4128-a0ff-791a68d33a8e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}","description":"<p>This resource allows you to show all data of a given account</p>\n<h2 id=\"response\">Response</h2>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>externalIdentifier</td>\n<td><code>string</code></td>\n<td>The account's reference</td>\n</tr>\n<tr>\n<td>locale</td>\n<td><code>string</code></td>\n<td>The account's locale</td>\n</tr>\n<tr>\n<td>name</td>\n<td><code>string</code></td>\n<td>The account's name</td>\n</tr>\n<tr>\n<td>firstName</td>\n<td><code>string</code></td>\n<td>The account's first name or <code>null</code> if it wasn't defined</td>\n</tr>\n<tr>\n<td>lastName</td>\n<td><code>string</code></td>\n<td>The account's last name or <code>null</code> if it wasn't defined</td>\n</tr>\n<tr>\n<td>email</td>\n<td><code>string</code></td>\n<td>The account's email or <code>null</code> if it wasn't defined</td>\n</tr>\n<tr>\n<td>groups</td>\n<td><code>Array</code></td>\n<td>The list of all initial groups the account is in</td>\n</tr>\n<tr>\n<td>fields</td>\n<td><code>JSON object</code></td>\n<td>The account's fields based on your Digitaleo's network's fields</td>\n</tr>\n<tr>\n<td>emailSenders</td>\n<td><code>Array</code></td>\n<td>List of allowed sender email addresses</td>\n</tr>\n<tr>\n<td>defaultEmailSender</td>\n<td><code>string</code></td>\n<td>Default email sender name</td>\n</tr>\n<tr>\n<td>defaultReplyTo</td>\n<td><code>string</code></td>\n<td>Default reply-to email address</td>\n</tr>\n</tbody>\n</table>\n</div><h3 id=\"response-1\">Response</h3>\n<p>It will respond with a <code>200 Ok</code> if it succeed. Here's a response example :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"externalIdentifier\": \"ORG_1234\",\n    \"locale\": \"fr_FR\",\n    \"name\": \"ORG [1234] Rennes\",\n    \"firstName\": \"Jean\",\n    \"lastName\": \"Michel\",\n    \"email\": \"jean.michel@acme.com\",\n    \"groups\": [\n        \"ORG_RENNES\"\n    ],\n    \"fields\": {\n        \"businessAddress1\": \"20 Avenue Jules Maniez\",\n        \"businessCity\": \"Rennes\"\n    },\n    \"dateCreated\": \"2020-01-21 15:00:00\",\n    \"dateUpdated\": \"2020-01-21 15:05:00\"\n}\n\n</code></pre>\n","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{backOfficeAccountReference}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"36428eb2-94c2-40ed-b83b-a65da0d670da","name":"On success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"externalIdentifier\": \"{{backOfficeAccountReference}}\",\n    \"locale\": \"fr_FR\",\n    \"name\": \"ORG [1234] Rennes\",\n    \"firstName\": \"Jean\",\n    \"lastName\": \"Michel\",\n    \"email\": \"jean.michel@acme.com\",\n    \"groups\": [\n        \"ORG_RENNES\"\n    ],\n    \"fields\": {\n        \"businessAddress1\": \"20 Avenue Jules Maniez\",\n        \"businessCity\": \"Rennes\"\n    },\n    \"dateCreated\": \"2020-01-21 15:00:00\",\n    \"dateUpdated\": \"2020-01-21 15:05:00\"\n}"},{"id":"d4edefa7-1d3d-4e5d-9da9-8c9eb7b74286","name":"Account not found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/open/v1/accounts/{{backOfficeAccountReference}}"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"error\": {\n        \"message\": \"Not Found\",\n        \"status_code\": 404\n    }\n}"}],"_postman_id":"e1b75ce8-0e60-4128-a0ff-791a68d33a8e"},{"name":"Update existing account","id":"ea03d096-a4ba-41ed-a6e2-60b12c84be51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"firstName\": \"Patrick\",\n\t\"email\": \"patrick.michel@acme.com\",\n\t\"fields\": {\n\t\t\"businessAddress1\": \"22 Avenue Jules Maniez\"\n\t}\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}","description":"<p>This resource allows you to update the basic informations for a given account</p>\n<h1 id=\"payload\">Payload</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n<th>Required ?</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>name</td>\n<td><code>string(255)</code></td>\n<td>This field will be used to label your account. Can't be set to <code>null</code></td>\n<td>no</td>\n</tr>\n<tr>\n<td>firstName</td>\n<td><code>string(255)</code></td>\n<td>This field will be used to label your account</td>\n<td>no</td>\n</tr>\n<tr>\n<td>lastName</td>\n<td><code>string(255)</code></td>\n<td>This field should be used if you want to customize the account's holder last name</td>\n<td>no</td>\n</tr>\n<tr>\n<td>email</td>\n<td><code>string(255)</code></td>\n<td>This field should be used if you want to customize the account's holder email</td>\n<td>no</td>\n</tr>\n<tr>\n<td>fields</td>\n<td><code>JSON object</code></td>\n<td>This field should be used to initialize account's fields based on your Digitaleo's network's fields</td>\n<td>no</td>\n</tr>\n<tr>\n<td>emailSenders</td>\n<td>array of strings</td>\n<td>List of allowed sender email addresses. Each item must be a valid email. Pass null to clear, [] to empty the list. Each sender domain <strong>must be validated in advance by Digitaleo</strong>.  <br />Contact your customer success manager to get the list of approved sender domains.</td>\n<td>no</td>\n</tr>\n<tr>\n<td>defaultEmailSender</td>\n<td>string</td>\n<td>Default email sender name. Pass null to clear the value</td>\n<td>no</td>\n</tr>\n<tr>\n<td>defaultReplyTo</td>\n<td>string</td>\n<td>Default reply-to email address. Must be a valid email. Pass null to clear</td>\n<td>no</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"response\">Response</h1>\n<p>It will respond with a <code>204 No content</code> if it succeed. The Location header will contain the link to the entity.</p>\n","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{backOfficeAccountReference}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"4f55f0a2-0e3a-4a22-8159-9d1e4068b67f","name":"On success","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"firstName\": \"Patrick\",\n\t\"email\": \"patrick.michel@acme.com\"\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7b3d6f66-476f-4831-86d5-b8260ac8b484","name":"On validation error","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","type":"text","value":"application/json"},{"key":"Authorization","type":"text","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n\t\"firstName\": \"Patrick\",\n\t\"email\": \"patrick.michel@acme.com\",\n\t\"lastName\": \"Patric a également un très long nom de famille qui pousse cet API à renvoyer une erreur de validation du champs car la limite de ce dernier est de 255 caractères. De ce fait cet exemple montre comment notre API gère ce type de problème avec la réponse approriée (body + headers).\",\n\t\"groups\": [\n\t\t\"Another group that does not exists\"\n\t]\n}"},"url":"https://api.digitaleo.com/open/v1/accounts/{{backOfficeAccountReference}}"},"status":"Expectation Failed","code":417,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data failed to pass validation.\",\n    \"errorCode\": \"INVALID_PARAMETERS\",\n    \"messages\": [\n        {\n            \"field\": \"lastName\",\n            \"errorCode\": \"INVALID_PARAMETER\",\n            \"message\": \"The name must be 255 characters.\",\n            \"details\": \"The name must be 255 characters.\"\n        },\n\t\t{\n\t\t\t\"field\": \"groups\",\n\t\t\t\"errorCode\": \"INVALID_PARAMETER\",\n\t\t\t\"message\": \"The group [Another group that does not exists] does not exists\",\n\t\t\t\"details\": \"The group [Another group that does not exists] does not exists\"\n\t\t}\n    ]\n}"}],"_postman_id":"ea03d096-a4ba-41ed-a6e2-60b12c84be51"},{"name":"Delete existing account","id":"654570ef-bfcb-4206-b1c3-4ddc1e7aca2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}","type":"text"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}","description":"<p>This resource allows you to permanently delete a given account. <strong>Be careful, you won't be able to activate it again</strong>.</p>\n<h2 id=\"response\">Response</h2>\n<p>It will respond with a <code>204 No content</code> if it succeed. This resource will <strong>fail silently</strong> if the given account does not exists.</p>\n","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{backOfficeAccountReference}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"2f861421-3441-4836-a56c-0caa01aafc87","name":"On success","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}","type":"text"}],"url":"https://api.digitaleo.com/open/v1/accounts/{{backOfficeAccountReference}}"},"status":"No Content","code":204,"_postman_previewlanguage":"Text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"654570ef-bfcb-4206-b1c3-4ddc1e7aca2d"}],"id":"30e55bfe-f6ce-45ee-a3ce-26144eabe233","description":"<p>This resources allows you to manage accounts.</p>\n","_postman_id":"30e55bfe-f6ce-45ee-a3ce-26144eabe233"},{"name":"Users","item":[{"name":"Add a user to an existing account","id":"2fcf02c8-2571-4c64-8b15-8446e633f342","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"userExternalIdentifier\": \"{{userExternalIdentifier}}\",\r\n    \"email\": \"evelyn.carter@acme.com\",\r\n    \"login\": \"evelyn.carter@acme.com\",\r\n    \"firstName\": \"Evelyn\",\r\n    \"lastName\": \"CARTER\",\r\n    \"locale\": \"en_GB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{accountExternalIdentifier}}/users","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{accountExternalIdentifier}}","users"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2fcf02c8-2571-4c64-8b15-8446e633f342"},{"name":"Lists the users of an account","id":"28a396f0-8bfd-4c7d-931d-591ef5d32277","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{accountExternalIdentifier}}/users","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{accountExternalIdentifier}}","users"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"28a396f0-8bfd-4c7d-931d-591ef5d32277"},{"name":"Read a user","id":"7d45f201-c15a-4dde-904c-5ff7c4a0b0ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{accountExternalIdentifier}}/users/{{userExternalIdentifier}}","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{accountExternalIdentifier}}","users","{{userExternalIdentifier}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7d45f201-c15a-4dde-904c-5ff7c4a0b0ec"},{"name":"Delete a user","id":"12881b44-230f-4400-8e1d-c1f2e4ea72e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{accountExternalIdentifier}}/users/{{userExternalIdentifier}}","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{accountExternalIdentifier}}","users","{{userExternalIdentifier}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"12881b44-230f-4400-8e1d-c1f2e4ea72e6"},{"name":"Update a user","id":"6efa5d49-8ab0-46bb-b510-ecc1b838abf8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"email\": \"evelyn.carter@acme.com\",\r\n    \"login\": \"evelyn.carter@acme.com\",\r\n    \"firstName\": \"Evelyn\",\r\n    \"lastName\": \"CARTER\",\r\n    \"locale\": \"en_GB\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{accountExternalIdentifier}}/users/{{userExternalIdentifier}}","description":"<p>This action allows you to modify user information</p>\n<h1 id=\"payload\">Payload</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>firstName</td>\n<td><code>string(255)</code></td>\n<td>User's first name</td>\n</tr>\n<tr>\n<td>lastName</td>\n<td><code>string(255)</code></td>\n<td>User's last name</td>\n</tr>\n<tr>\n<td>email</td>\n<td><code>string(255)</code></td>\n<td>User's email address</td>\n</tr>\n<tr>\n<td>login</td>\n<td><code>string(255)</code></td>\n<td>User's login</td>\n</tr>\n<tr>\n<td>locale</td>\n<td><code>string(5)</code></td>\n<td>User's locale</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"response\">Response</h1>\n<p>It will respond with a <code>204 No content</code> if it succeed. The Location header will contain the link to the entity.</p>\n<h1 id=\"list-of-possible-errors\">List of possible errors</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Http code</th>\n<th>Error message</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><code>400 Bad Request</code></td>\n<td>Your login template configuration is not defined. Please contact customer service: <a href=\"https://mailto:serviceclient@digitaleo.com\">serviceclient@digitaleo.com</a>.</td>\n</tr>\n<tr>\n<td><code>404 Not Found</code></td>\n<td>Account with external identifier [{{accountExternalIdentifier}}] could not be found</td>\n</tr>\n<tr>\n<td><code>404 Not Found</code></td>\n<td>User with external identifier [{{userExternalIdentifier}}] of account [{{accountExternalIdentifier}}] already exists</td>\n</tr>\n<tr>\n<td><code>409 Conflict</code></td>\n<td>Login [{{login}}] is not available</td>\n</tr>\n<tr>\n<td><code>417 Expectation Failed</code></td>\n<td>Login [{{login}}] is not valid</td>\n</tr>\n<tr>\n<td><code>500 Internal Error</code></td>\n<td>Something went wrong on Digitaleo’s end. (These are rare.)</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{accountExternalIdentifier}}","users","{{userExternalIdentifier}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"6efa5d49-8ab0-46bb-b510-ecc1b838abf8"}],"id":"36e26340-6d4d-40da-a9ae-2aa77d58c90d","description":"<p>This resource can be used to handle additional users to an account.</p>\n","_postman_id":"36e26340-6d4d-40da-a9ae-2aa77d58c90d"},{"name":"Businesses","item":[{"name":"Update existing business","id":"5ae8984e-89be-4620-b964-d47bdcc13c52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"nom\",\n    \"tradeName\": \"raison social\",\n    \"nafCode\": \"5829A\",\n    \"registrationNumber\": \"73282932000074 \",\n    \"address\": \"36 Quai aux Fleurs\",\n    \"address2\": \"ma suite d'adresse\",\n    \"zipCode\": \"63690\",\n    \"city\": \"Tauves\",\n    \"phone\": \"33163839928\",\n    \"contactEmail\": \"contact@contact.com\",\n    \"website\": \"https://www.dressingshop.com/Rennes\",\n    \"schedules\": [\n        {\n            \"label\": \"Monday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Tuesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"00:15\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Wednesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Thursday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Friday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Saturday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Sunday\",\n            \"timetableSlots\": []\n        }\n    ]\n}"},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}/businesses/{{storeCode}}","description":"<p>This resource allows you to update informations for a given business. It only update existing business, it will not create business.</p>\n<blockquote>\n<p><strong>⚠️ Warning:</strong> Updating a business will automatically publish it, even if it's in draft status. Use with caution. </p>\n</blockquote>\n<h1 id=\"payload\">Payload</h1>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n<th>Required ?</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>name</td>\n<td><code>string(50)</code></td>\n<td>Name displays on publishers</td>\n<td>no</td>\n</tr>\n<tr>\n<td>tradeName</td>\n<td><code>string(50)</code></td>\n<td>Name of the company</td>\n<td>no</td>\n</tr>\n<tr>\n<td>nafCode</td>\n<td><code>string</code></td>\n<td>Activity code</td>\n<td>no</td>\n</tr>\n<tr>\n<td>registrationNumber</td>\n<td><code>string</code></td>\n<td>Siret registration number</td>\n<td>no</td>\n</tr>\n<tr>\n<td>address</td>\n<td><code>string(50)</code></td>\n<td>Address where the business is located</td>\n<td>no</td>\n</tr>\n<tr>\n<td>address2</td>\n<td><code>string(50)</code></td>\n<td>Second line of the business address</td>\n<td>no</td>\n</tr>\n<tr>\n<td>zipCode</td>\n<td><code>string(5)</code></td>\n<td>Zip code of the city where the business is located</td>\n<td>no</td>\n</tr>\n<tr>\n<td>city</td>\n<td><code>string(50)</code></td>\n<td>City where the business is located</td>\n<td>no</td>\n</tr>\n<tr>\n<td>phone</td>\n<td><code>string</code></td>\n<td>Phone number displays on publishers (local or international format is accepted)</td>\n<td>no</td>\n</tr>\n<tr>\n<td>contactEmail</td>\n<td><code>string</code></td>\n<td>Email displays on publishers</td>\n<td>no</td>\n</tr>\n<tr>\n<td>schedules</td>\n<td><code>JSON object</code></td>\n<td>This field should be used to initialize account's fields based on your Digitaleo's network's fields</td>\n<td>no</td>\n</tr>\n<tr>\n<td>website</td>\n<td>string</td>\n<td>URL of the Business website</td>\n<td>no</td>\n</tr>\n</tbody>\n</table>\n</div><h1 id=\"format\">Format</h1>\n<p>Schedule must be of this format :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code>\"schedules\": [\n        {\n            \"label\": \"Monday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Tuesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"09:00\",\n                    \"end\": \"12:00\"\n                },\n                {\n                    \"start\": \"14:00\",\n                    \"end\": \"18:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Wednesday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Thursday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Friday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Saturday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Sunday\",\n            \"timetableSlots\": []\n        }\n    ]\n\n</code></pre><p>Schedules must contain 7 items. One for each day of the week. Each item contain a label (day of week) and an array of timetableSlots.<br />Each timetableSlot has a start and end hours. These slots describe opening hour of businesse. If timetableSlot is empty business is considered closed for the given day.</p>\n<h1 id=\"response\">Response</h1>\n<p>It will respond with a <code>202 Acceped</code> if the payload is correct. The request has been accepted for processing, but the processing has not been yet ompleted. The request might or might not be acted</p>\n","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{backOfficeAccountReference}}","businesses","{{storeCode}}"],"host":["api","digitaleo","com"],"query":[],"variable":[]}},"response":[{"id":"1b607894-c929-4348-9ff8-384071ec4f65","name":"On accepted","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"nom\",\n    \"tradeName\": \"raison social\",\n    \"nafCode\": \"5829A\",\n    \"registrationNumber\": \"73282932000074 \",\n    \"address\": \"36 Quai aux Fleurs\",\n    \"address2\": \"ma suite d'adresse\",\n    \"zipCode\": \"63690\",\n    \"city\": \"Tauves\",\n    \"phone\": \"33163839928\",\n    \"contactEmail\": \"contact@contact.com\",\n    \"schedules\": [\n        {\n            \"label\": \"Monday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Tuesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"00:15\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Wednesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Thursday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Friday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Saturday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Sunday\",\n            \"timetableSlots\": []\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}/businesses/{{storeCode}}"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Mar 2022 10:30:14 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"Vary","value":"Authorization"}],"cookie":[],"responseTime":null,"body":""},{"id":"3f40985e-ccd8-4d50-8ade-cacaee4b810f","name":"On validation error","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"body":{"mode":"raw","raw":"{\n    \"name\": \"nom\",\n    \"tradeName\": \"raison social\",\n    \"nafCode\": \"5829A\",\n    \"registrationNumber\": \"73282932000074 \",\n    \"address\": \"36 Quai aux Fleurs\",\n    \"address2\": \"ma suite d'adresse\",\n    \"zipCode\": \"73690\",\n    \"city\": \"Tauves\",\n    \"phone\": \"331638399281\",\n    \"contactEmail\": \"contact@contact.com\",\n    \"schedules\": [\n        {\n            \"label\": \"Monday\",\n            \"timetableSlots\": []\n        },\n        {\n            \"label\": \"Tuesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"00:15\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Wednesday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Thursday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Friday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Saturday\",\n            \"timetableSlots\": [\n                {\n                    \"start\": \"10:00\",\n                    \"end\": \"19:00\"\n                }\n            ]\n        },\n        {\n            \"label\": \"Sunday\",\n            \"timetableSlots\": []\n        }\n    ]\n}","options":{"raw":{"language":"json"}}},"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}/businesses/{{storeCode}}"},"status":"Expectation Failed","code":417,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 02 Mar 2022 10:29:21 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private, must-revalidate"},{"key":"pragma","value":"no-cache"},{"key":"expires","value":"-1"},{"key":"Vary","value":"Authorization"}],"cookie":[],"responseTime":null,"body":"{\n    \"message\": \"The given data failed to pass validation.\",\n    \"errorCode\": \"INVALID_PARAMETERS\",\n    \"messages\": [\n        {\n            \"field\": \"phone\",\n            \"errorCode\": \"INVALID_PARAMETER\",\n            \"message\": \"Phone number is not valid\",\n            \"details\": \"Phone number is not valid\"\n        },\n        {\n            \"field\": \"city\",\n            \"errorCode\": \"INVALID_PARAMETER\",\n            \"message\": \"no match between city Tauves and zipcode 73690\",\n            \"details\": \"no match between city Tauves and zipcode 73690\"\n        }\n    ]\n}"}],"_postman_id":"5ae8984e-89be-4620-b964-d47bdcc13c52"},{"name":"Show linked businesses","id":"ec0b2ed1-ccd7-450d-877f-a8a8098f64dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}","type":"text"}],"url":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}/businesses","description":"<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>name</td>\n<td>string(50)</td>\n<td>Name displays on publishers</td>\n</tr>\n<tr>\n<td>storeCode</td>\n<td>string(50)</td>\n<td>Store code</td>\n</tr>\n<tr>\n<td>contractName</td>\n<td>string(255)</td>\n<td>Linked account's name</td>\n</tr>\n<tr>\n<td>tradeName</td>\n<td>string(50)</td>\n<td>Name of the company</td>\n</tr>\n<tr>\n<td>nafCode</td>\n<td>string</td>\n<td>Activity code</td>\n</tr>\n<tr>\n<td>registrationNumber</td>\n<td>string</td>\n<td>Siret registration number</td>\n</tr>\n<tr>\n<td>address</td>\n<td>string(50)</td>\n<td>Address where the business is located</td>\n</tr>\n<tr>\n<td>address2</td>\n<td>string(50)</td>\n<td>Second line of the business address</td>\n</tr>\n<tr>\n<td>zipCode</td>\n<td>string(5)</td>\n<td>Zip code of the city where the business is located</td>\n</tr>\n<tr>\n<td>city</td>\n<td>string(50)</td>\n<td>City where the business is located</td>\n</tr>\n<tr>\n<td>phone</td>\n<td>string</td>\n<td>Phone number displays on publishers (local or international format is accepted)</td>\n</tr>\n<tr>\n<td>contactEmail</td>\n<td>string</td>\n<td>Email displays on publishers</td>\n</tr>\n<tr>\n<td>schedules</td>\n<td>JSON object</td>\n<td>Normal business' schedules</td>\n</tr>\n<tr>\n<td>banner</td>\n<td>string(255)</td>\n<td>Displayed banner</td>\n</tr>\n<tr>\n<td>country</td>\n<td>string(50)</td>\n<td>Business' country</td>\n</tr>\n<tr>\n<td>customSchedules</td>\n<td>JSON object</td>\n<td>Special business' schedules (holidays, etc...)</td>\n</tr>\n<tr>\n<td>reviewStatistics</td>\n<td>JSON object</td>\n<td>Contains the number of total reviews and the global average score</td>\n</tr>\n<tr>\n<td>reviewsList</td>\n<td>JSON object</td>\n<td>Contains the last 15 reviews with a score greater or equals to 4</td>\n</tr>\n<tr>\n<td>reviewUrls</td>\n<td>ReviewUrl[]</td>\n<td>List of ReviewUrl object.</td>\n</tr>\n<tr>\n<td>website</td>\n<td>string</td>\n<td>URL of the business website</td>\n</tr>\n</tbody>\n</table>\n</div><p>ReviewUrl</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th>Field</th>\n<th>Data Type</th>\n<th>Description</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>id</td>\n<td>string(50)</td>\n<td>Publishers'id (eg: google)</td>\n</tr>\n<tr>\n<td>url</td>\n<td>string(255)</td>\n<td>Link to add review. If the data is not available, the property is null</td>\n</tr>\n</tbody>\n</table>\n</div>","urlObject":{"protocol":"https","path":["back-office","v1","accounts","{{backOfficeAccountReference}}","businesses"],"host":["api","digitaleo","com"],"query":[{"disabled":true,"description":{"content":"<p>Will append the reviewsList property. It will return the last 15 reviews with a score greater than 4</p>\n","type":"text/plain"},"key":"withReviewsList","value":"true"},{"disabled":true,"description":{"content":"<p>Will append the reviewStatistics property. It will return the total number of reviews and the average rating</p>\n","type":"text/plain"},"key":"withReviewStatistics","value":"true"}],"variable":[]}},"response":[{"id":"b6a85210-b490-4cfd-a6b3-75e489222f45","name":"On success","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{backOfficeMasterToken}}"}],"url":{"raw":"https://api.digitaleo.com/back-office/v1/accounts/{{backOfficeAccountReference}}/businesses?withReviewsList=1&withReviewStatistics=1","protocol":"https","host":["api","digitaleo","com"],"path":["back-office","v1","accounts","{{backOfficeAccountReference}}","businesses"],"query":[{"key":"withReviewsList","value":"1"},{"key":"withReviewStatistics","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text","enabled":true}],"cookie":[],"responseTime":null,"body":"[\n    {\n        \"id\": \"5918301\",\n        \"name\": \"Burger SHop\",\n        \"tradeName\": \"raison social\",\n        \"storeCode\": \"MY_CUSTOM_CODE\",\n        \"contractName\": \"My digitaleo contract's name\",\n        \"reviewStatistics\": {\n            \"count\": 18,\n            \"averageScore\": 4.33\n        },\n        \"reviewsList\": [\n            {\n                \"id\": \"64086496705d877692143b98\",\n                \"businessId\": \"64086488a139016c5c59052e\",\n                \"publisherId\": \"facebook\",\n                \"author\": {\n                    \"displayName\": \"Yann Comiere\"\n                },\n                \"text\": \"Bonne qualité des articles, ma deuxième boutique préférée. De très belles pièces, passant de la tenue décontractée au chic. J'adore !\",\n                \"score\": 5,\n                \"recommendation\": \"positive\",\n                \"datePublished\": \"2023-01-30 14:15:00\",\n                \"replies\": []\n            },\n            {\n                \"id\": \"64086497f47a9a6ee60b8b71\",\n                \"businessId\": \"64086488a139016c5c59052e\",\n                \"publisherId\": \"google_my_business\",\n                \"author\": {\n                    \"displayName\": \"Yannick Rohou\"\n                },\n                \"text\": \"Bonjour. Un lieu très accueillant. C'est extrêmement bien organisé et le personnel est très agréable.\",\n                \"score\": 4,\n                \"recommendation\": null,\n                \"datePublished\": \"2023-01-21 14:15:00\",\n                \"replies\": [\n                    {\n                        \"id\": \"64086497f47a9a6ee60b8b6f\",\n                        \"externalId\": null,\n                        \"text\": \"Ça fait plaisir ! À bientôt 😃\",\n                        \"datePublished\": \"2023-01-28 14:15:00\",\n                        \"contractId\": 142232,\n                        \"userId\": 470162,\n                        \"dateCreated\": null,\n                        \"dateUpdated\": null,\n                        \"dateDeleted\": null,\n                        \"status\": \"\",\n                        \"statusDetail\": null\n                    }\n                ]\n            }\n        ],\n        \"reviewUrls\": [\n            {\n                \"id\": \"google\",\n                \"url\": \"https://search.google.com/local/writereview?placeid=ChIJy_FlpDUeD0gRhK35JNLi5BE\"\n            }\n        ]\n    }\n]"}],"_postman_id":"ec0b2ed1-ccd7-450d-877f-a8a8098f64dd"}],"id":"c72de6ae-a26d-4d02-b840-70a5ab78d7f2","description":"<p>This resources allows you to manage businesses profiles online. Businesses profiles are published on multiple platforms such as Google My Business.</p>\n<h3 id=\"glossary\">Glossary</h3>\n<ul>\n<li><strong>externalIdentifier</strong>: the account wich the business is related to</li>\n<li><strong>storeCode</strong>: this resource use the same id that used by Google My Business to identify a business</li>\n</ul>\n","_postman_id":"c72de6ae-a26d-4d02-b840-70a5ab78d7f2"}],"id":"67b570d3-1bcb-4b5a-a3b5-bd96ea25feec","description":"<p>This section describes all the available resources.</p>\n","_postman_id":"67b570d3-1bcb-4b5a-a3b5-bd96ea25feec"},{"name":"Authentication","item":[{"name":"Obtain account's access token","event":[{"listen":"test","script":{"id":"2a91ab10-a352-4871-9b19-bd6febd555d0","exec":["const data = JSON.parse(responseBody);\r","\r","pm.environment.set(\"backOfficeAccountToken\", data.access_token);"],"type":"text/javascript"}}],"id":"4f849b7f-1d9e-413d-a314-11c1e4d545fc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"client_id\": \"{{backOfficeMasterClientId}}\",\n\t\"client_secret\": \"{{backOfficeMasterClientSecret}}\",\n\t\"grant_type\": \"login_as\",\n\t\"external_identifier\": \"{{backOfficeExternalIdentifier}}\"\n}"},"url":"https://oauth.messengeo.net/token","description":"<p>This resource must be used to retrieve an access token in order to connect directly to app.digitaleo.com with <code>external_identifier</code>. This is a oAuth2 request using <code>login_as</code> grant type.</p>\n<h1 id=\"response\">Response</h1>\n<p>It will respond with a <code>200 Ok</code> if it succeed. Here's a response example :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"access_token\": \"...\",\n    \"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": \"basic\"\n}\n</code></pre>\n","urlObject":{"protocol":"https","path":["token"],"host":["oauth","messengeo","net"],"query":[],"variable":[]}},"response":[{"id":"6b342b1c-5ce4-416b-a53b-c8acca737d7d","name":"On success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"client_id\": \"{{backOfficeMasterClientId}}\",\n\t\"client_secret\": \"{{backOfficeMasterClientSecret}}\",\n\t\"grant_type\": \"login_as\",\n\t\"externalIdentifier\": \"{{backOfficeExternalIdentifier}}\"\n}"},"url":"https://oauth.messengeo.net/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n    \"access_token\": \"YOUR ACCOUNT ACCESS TOKEN HERE\",\n    \"expires_in\": 3600,\n    \"token_type\": \"bearer\",\n    \"scope\": \"basic\"\n}"}],"_postman_id":"4f849b7f-1d9e-413d-a314-11c1e4d545fc"},{"name":"Auto login on app.digitaleo.com","id":"bba32b4e-f90d-4485-8587-f21b6da173c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"application/json"},{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"access_token","value":"{{backOfficeAccountToken}}","type":"text"}]},"url":"https://app.digitaleo.com/auth/login","description":"<p>This resource must be used to auto login an account on our platform using an access token.</p>\n<h2 id=\"html-form-example\">HTML form example</h2>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-html\">&lt;html&gt;\n&lt;head&gt;\n    &lt;title&gt;Test redirection vers APP&lt;/title&gt;\n&lt;/head&gt;\n&lt;body&gt;\n    &lt;form method=\"post\"\n          enctype=\"application/json\"\n          action=\"https://app.digitaleo.com/auth/login/\"&gt;\n        &lt;input type='hidden' name='access_token' value='{{openChildAccountToken}}'&gt;\n        &lt;button type=\"submit\" value=\"Submit\"&gt;\n            Redirection automatique vers app.digitaleo.com\n        &lt;/button&gt;\n    &lt;/form&gt;\n&lt;/body&gt;\n&lt;/html&gt;\n</code></pre>\n","urlObject":{"protocol":"https","path":["auth","login"],"host":["app","digitaleo","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bba32b4e-f90d-4485-8587-f21b6da173c4"}],"id":"ab595609-8212-467c-b5cc-220fdf661057","description":"<p>This section describes how to retrieve authentication</p>\n<p>We currently provides 2 ways of integrating an authentication system with our platform</p>\n<h2 id=\"openid\">OpenID</h2>\n<p>We currently supports 2 OpenID connectors out of the box to help you integrate an external authorization service in our platform :</p>\n<ul>\n<li>a Generic OpenID 2 provider</li>\n<li>a Keycloak provider</li>\n</ul>\n<p>Please contact your seller or your customer success manager to get more informations.</p>\n<h2 id=\"full-custom-connector\">Full custom connector</h2>\n<p>If you do not have any authorization service or if you want to integrate our authentication system yourself, you can refer to the next section of this documentation to develop a full custom connecter based on your need.</p>\n<p><strong>You didn't found what you were looking for ?</strong></p>\n<p>If any of this solutions do not fit to your needs, please contact your seller or your customer success manager.</p>\n","event":[{"listen":"prerequest","script":{"id":"6290dcca-ddc6-4c61-b378-5fe3a000f9d9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aa7546b8-b6ba-4281-9a5e-d6d3a66a3ab3","type":"text/javascript","exec":[""]}}],"_postman_id":"ab595609-8212-467c-b5cc-220fdf661057"}]}