Asignar, renovar o cambiar el plan de una empresa
POST/api/ubl2.1/config/:nit/:dv
CONFIGURAR COMPAÑIA
- Si se instalo un dominio se debe utilizar de la siguiente manera:
http://midominio.com/api/ubl2.1/config/89008003/2
-
Requiere el header X-Admin-Token con la clave de administracion de la instalacion (PLATFORM_ADMIN_TOKEN del .env, la crea php artisan api:admin-token). Solo responde sin esa clave mientras la instalacion tenga ALLOW_PUBLIC_API_REGISTER=true, que es un modo temporal.
-
En URL los ultimos dos parametros son NIT y digito de verificacion de la empresa.
.../ubl2.1/config/NitEmpresa/DigitoVerificacion
- Los datos necesarios para llenar los campos JSON cuyo nombre finalice con "_id" se encuentran en las tablas parametricas de la base de datos de la API, ejemplo:
type_liability_id, se debe especificar el id del registro correspondiente de la tabla type_liabilities de la base de datos de la API.
- Devuelve un token en el response, si fue posible la creacion de la empresa, este token es una cadena alfanumerica en el campo API_TOKEN, este dato es necesario para utilizarlo como autorizacion (header Authorization: Bearer {api_token}) en los siguientes endpoints de la API. Guardelo: si se pierde, no se consulta en la base de datos, se cambia con php artisan api:rotate-token {nit} o con PUT /api/ubl2.1/config/rotate-token/{nit} usando el header X-Admin-Token.
Request
Headers
| Header | Valor |
|---|---|
Content-Type | application/json |
Accept | application/json |
X-Admin-Token | <SU_CLAVE_DE_ADMINISTRACION> |
Responses
- 200
Successful response