Registrar organización cliente

POST

/business/v1/businesses/{businessUuid}/business-collaborators

Crea una organización cliente en estado CREATED, la vincula al colaborador que realiza la llamada (la
organización identificada por el parámetro de ruta y la cabecera de tenant) con el collaboratorType
declarado, registra su catálogo inicial de productos y dispara una invitación para cada usuario inicial.
El vínculo queda fijado al rol declarado. El llamante no se convierte en usuario ni administrador de
la organización creada.

El campo products selecciona cuáles de los productos activos del propio colaborador que realiza la
llamada se registran para el cliente: si se omite, se toman por defecto todos los productos activos que
el propio colaborador tiene bajo el collaboratorType declarado; si está presente, cada código declarado
debe ser uno de ellos.

Reglas de seguridad:

• La cabecera x-tenant-id debe coincidir con el parámetro de ruta businessUuid.
• La cabecera x-tenant-id debe coincidir con el claim tenant_id contenido en el token de acceso (JWT).

Autorizaciones

OAuth2ClientCredentials

OAuth2 Client Credentials para acceso máquina a máquina. El token de acceso debe incluir el scope API_INTERNAL (servicio a servicio interno) o API (integraciones M2M externas).

clientCredentials Flow

URL del token"/idp/oauth2/token"

Ámbitos:

• "API_INTERNAL"Internal API scope
• "API"External M2M API scope

Parámetros

Header Parameters

x-tenant-id*

Identificador del tenant que contiene el UUID de la organización

Tipo

string

Requerido

Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"

Formato

"uuid"

Path Parameters

businessUuid*

Identificador único de la organización.

Tipo

string

Requerido

Ejemplo"1f56c928-7621-44fe-8cda-c211fda0a828"

Formato

"uuid"

Cuerpo de la petición

application/json

{

  

"taxId": "7377473W",

  

"type": "COMPANY",

  

"legalName": "My company",

  

"tradeName": "My company trade name",

  

"name": "My name",

  

"lastName": "My last name",

  

"activityCode": "20",

  

"fiscalAddress": {

  

  

"street": "Calle Uría",

  

  

"additionalInformation": "Whatever additional information",

  

  

"postalCode": "33010",

  

  

"cityCode": "ES-AS-OVIEDO",

  

  

"stateCode": "ES-AS",

  

  

"countryCode": "ES"

  

},

  

"collaboratorType": "PARTNER",

  

"users": [

  

  

{

  

  

  

"name": "Jane",

  

  

  

"lastName": "Doe",

  

  

  

"email": "[email protected]",

  

  

  

"role": "ADMINISTRATOR"

  

  

}

  

],

  

"products": [

  

  

[

  

  

  

"pagafactu",

  

  

  

"zertipay"

  

  

]

  

]

}

Respuestas

Organización registrada; invitaciones disparadas.

Content-Type

application/json

{

  

"businessUuid": "1f56c928-7621-44fe-8cda-c211fda0a828",

  

"products": [

  

  

[

  

  

  

"pagafactu",

  

  

  

"zertipay"

  

  

]

  

]

}

POST

/business/v1/businesses/{businessUuid}/business-collaborators

Playground

Servidor

Autorización

OAuth2ClientCredentials

Headers

x-tenant-id*

Variables

Key

Value

businessUuid*

Cuerpo

Ejemplos