Create/Search company config
Endpoint que permite crear o buscar una configuración de una compañía. En caso de que la compañía no exista, se creará. En caso de que la compañía exista, se retornará los datos de la configuración de esta.
Es necesario ingresar el siguiente parámetro por URL para hacer uso de este endpoint:
Key | Data Type | Example | Description |
---|---|---|---|
company_id | String | 3 | identificador de lac compañía |
Endpoint
Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json | |
Authorization | Bearer {{access_token}} | access_token obtained in Atenea |
Url
Method: POST
URL: https://api.trust.lat/config-company/api/companies/{{company_id}}
caution
Recuerda que para utilizar este endpoint es necesario un access token obtenido en el servicio Atenea
Body
Para ingresar los datos se hará body en formato JSON.
Key | Value | Type | Description |
---|---|---|---|
primary_color | "#DADDFC" | String (Hexadecimal color) | Código hexadecimal del color primario de la compañía |
secondary_color | "#FC997C" | String (Hexadecimal color) | Código hexadecimal del color secundario de la compañía |
image_url | https://picsum.photos/300/200 | String (URL) | URL de la imagen de la compañía a usarse en emails y apps |
verification_primary_color | "#092A35" | String (Hexadecimal color) | Código hexadecimal del color primario para el servicio de mailing |
verification_secondary_color | "#FC997C" | String (Hexadecimal color) | Código hexadecimal del color secundario para el servicio de mailing |
verification_body | "Inserte su código de verificación en la aplicación" | String | Texto a mostrar en el correo de verificación |
option_1 | false | Boolean | Valor por defecto para la opción 1 de las aplicaciones de la compa ñía |
option_2 | false | Boolean | Valor por defecto para las opción 2 aplicaciones de la compañía |
option_3 | false | Boolean | Valor por defecto para las opción 3 aplicaciones de la compañía |
Code Examples
- Curl
- JavaScript
- Python
curl --location --request POST 'https://api.trust.lat/config-company/api/companies/3' \
--header 'Authorization: Bearer `{{access_token}}`' \
--data-raw '{
"verification_body" : "Inserte su código de verificación en la aplicación",
"verification_primary_color": "#092A35",
"verification_secondary_color": "#658525",
"image_url": "https://picsum.photos/300/200"
}'
import requests
url = "https://api.trust.lat/config-company/api/companies/3"
payload = "{\n \"verification_body\" : \"Inserte su código de verificación en la aplicación\",\n \"verification_primary_color\": \"#092A35\",\n \"verification_secondary_color\": \"#658525\",\n \"image_url\": \"https://picsum.photos/300/200\"\n}"
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
var axios = require('axios');
var data = '{\n "verification_body" : "Inserte su código de verificación en la aplicación",\n "verification_primary_color": "#092A35",\n "verification_secondary_color": "#658525",\n "image_url": "https://picsum.photos/300/200"\n}';
var config = {
method: 'post',
url: 'https://api.trust.lat/config-company/api/companies/3',
headers: {
'Authorization': 'Bearer {{accessToken}}',
...data.getHeaders()
},
data : data
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
Responses
HTTP Code: 200 OK - Found
{
"status": true,
"message": "Result of company_id '3'",
"data": {
"id": 1,
"company_id": "3",
"primary_color": null,
"secondary_color": null,
"verification_primary_color": "#052B70",
"verification_secondary_color": "#2FCD9D",
"option_1": false,
"option_2": true,
"option_3": false,
"created_at": "2021-11-25T20:52:14.265Z",
"updated_at": "2021-12-02T21:15:57.753Z",
"image_url": "https://picsum.photos/300/200",
"verification_body": "Inserte su código de verificación en la aplicación"
}
}
HTTP Code: 200 Created
{
"status": true,
"message": "The configuration has been created for the company_id '3' not finding matches",
"data": {
"id": 5,
"company_id": "3",
"primary_color": null,
"secondary_color": null,
"verification_primary_color": null,
"verification_secondary_color": null,
"option_1": false,
"option_2": true,
"option_3": false,
"created_at": "2021-12-15T20:58:48.501Z",
"updated_at": "2021-12-15T20:58:48.501Z",
"image_url": null,
"verification_body": null
}
}