Api Keys

Las API keys son utilizadas para autenticar las solicitudes en fiscalapi. Cada API key tiene un conjunto de roles y/o permisos asociados que determinan qué acciones puede realizar el usuario que la posee.

Modelo API Key

El modelo de API Key es un modelo de datos que representa una clave de autenticación en fiscalapi. Adicionalmente, la api también soporta autenticación basada en json web tokens JWT.

Propiedades

Name
id
Type
string?
Description
El identificador único de la API key.
Name
environment
Type
string?
Description
El entorno al que pertenece la API key.
Name
apiKeyValue
Type
string?
Description
El API key. Este valor es el que se utiliza para autenticar las solicitudes.
Name
personId
Type
string?
Description
El identificador único de la persona a la que pertenece la API key.
Name
tenantId
Type
string?
Description
El identificador único del tenant al que pertenece la API key.
Name
apiKeyStatus
Type
string?
Description
El estado de la API key.
Type
enum:
Values
01
Name
description
Type
string?
Description
Nombre o description de la API key.

GET/api/v4/apikeys

Listar api-keys

Este endpoint te permite recuperar una lista paginada de todas las api-keys de su organización. De forma predeterminada, se muestran diez apikeys por página, pero puedes ajustar esto con los parámetros de consulta.

Query parameters

Name
pageNumber
Type
int
required
Description
El número de página que se desea recuperar.
Default:
1
Name
pageSize
Type
int
required
Description
Valor entre 1 y 50 inclusivo para indicar la cantidad de registros devueltos por página.
Default:
10

Request

GET

/api/v4/apikeys?pageNumber=1&pageSize=2

curl --location 'https://localhost:7173/api/v4/apikeys?pageNumber=1&pageSize=2' \
--header 'X-TENANT-KEY: e839651d-1765-4cd0-ba7f-547a4c20580f' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: sk_development_e0e47dfa_5146_40c2_b3a3_3055909a6b88' \
--data ''

Response

{
    "data": {
        "items": [
            {
                "environment": "Test",
                "apiKeyValue": "sk_test_...",
                "personId": "3a12e4b6-642b-4a6b-ba73-c814e4c2c873",
                "tenantId": "e839651d-1765-4cd0-ba7f-547a4c20580f",
                "apiKeyStatus": 1,
                "id": "2be4288f-696f-4d13-bd03-d9565101ae51",
                "createdAt": "2025-01-07T14:25:14.1775384",
                "updatedAt": "2025-01-07T14:25:14.1775468"
            },
            {
                "environment": "Test",
                "apiKeyValue": "sk_test_...",
                "personId": "984708c4-fcc0-43bd-9d30-ec017815c20e",
                "tenantId": "e839651d-1765-4cd0-ba7f-547a4c20580f",
                "apiKeyStatus": 0,
                "id": "01e9860a-8d71-4b38-a319-ca5c6c51a166",
                "createdAt": "2025-01-11T22:29:11.3042301",
                "updatedAt": "2025-01-11T22:35:07.6645162"
            }
        ],
        "pageNumber": 1,
        "totalPages": 3,
        "totalCount": 6,
        "hasPreviousPage": false,
        "hasNextPage": true
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

POST/api/v4/apikeys

Crear Api-Key

Este endpoint te permite crear una nueva api-key para un usuario (persona) de su organización.

Modelo

Name
personId
Type
string?
Description
Id de la persona a la que se le asignará la api-key.

Request

POST

/v1/contacts

curl --location 'https://localhost:7173/api/v4/apikeys' \
--header 'X-TENANT-KEY: e839651d-1765-4cd0-ba7f-547a4c20580f' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: sk_development_e0e47dfa_5146_40c2_b3a3_3055909a6b88' \
--data '{
  "personId":"984708c4-fcc0-43bd-9d30-ec017815c20e" 
}'

Response

{
    "data": {
        "environment": "Test",
        "apiKeyValue": "sk_test_...",
        "personId": "984708c4-fcc0-43bd-9d30-ec017815c20e",
        "tenantId": "e839651d-1765-4cd0-ba7f-547a4c20580f",
        "apiKeyStatus": 1,
        "id": "0153a9b8-f219-46ba-a7b5-f4ec92bdfa26",
        "createdAt": "2025-01-11T23:11:08.8119134",
        "updatedAt": "2025-01-11T23:11:08.8119137"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

GET/api/v4/apikeys/{id}

Obtener Api-Key por ID

Este endpoint te permite crear una nueva api-key para un usuario (persona) de su organización.

Request

POST

/api/v4/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26

  curl --location 'https://localhost:7173/api/v4/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26' \
--header 'X-TENANT-KEY: e839651d-1765-4cd0-ba7f-547a4c20580f' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: sk_development_e0e47dfa_5146_40c2_b3a3_3055909a6b88' \
--data ''

Response

{
    "data": {
        "environment": "Test",
        "apiKeyValue": "sk_test_...",
        "personId": "984708c4-fcc0-43bd-9d30-ec017815c20e",
        "tenantId": "e839651d-1765-4cd0-ba7f-547a4c20580f",
        "apiKeyStatus": 1,
        "id": "0153a9b8-f219-46ba-a7b5-f4ec92bdfa26",
        "createdAt": "2025-01-11T23:11:08.8119134",
        "updatedAt": "2025-01-11T23:11:08.8119137"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

PUT/api/v4/apikeys/{id}

Actualizar Api-Key

Este endpoint te permite actualizar una nueva api-key para un usuario (persona) de su organización.

Modelo

Name
id
Type
string?
Description
Id de la api-key a actualizar.
Name
description
Type
string?
Description
Nombre o description de la API key.
Name
apiKeyStatus
Type
string?
Description
El estado de la API key.
Type
enum:
Values
01

Request

POST

/api/v4/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26

curl --location --request PUT 'https://localhost:7173/api/v4/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26' \
--header 'X-TENANT-KEY: e839651d-1765-4cd0-ba7f-547a4c20580f' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: sk_development_e0e47dfa_5146_40c2_b3a3_3055909a6b88' \
--data '{
  "id": "0153a9b8-f219-46ba-a7b5-f4ec92bdfa26",
  "description": "Api-key server 001",
  "apiKeyStatus": 1
}'

Response

{
    "data": {
        "environment": "Test",
        "apiKeyValue": "sk_test_...",
        "personId": "984708c4-fcc0-43bd-9d30-ec017815c20e",
        "tenantId": "e839651d-1765-4cd0-ba7f-547a4c20580f",
        "apiKeyStatus": 1,
        "description": "Api-key server 001",
        "id": "0153a9b8-f219-46ba-a7b5-f4ec92bdfa26",
        "createdAt": "2025-01-11T23:11:08.8119134",
        "updatedAt": "2025-01-11T23:26:19.0958976"
    },
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}

DELETE/api/v4/apikeys/{id}

Revocar Api-Key

Este endpoint te permite eliminar (revocar) una api-key de un usuario (persona) de su organización.

Request

POST

/api/v4/apikeys/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26

curl --location --request DELETE 'https://localhost:7173/api/v4/apikeys/0153a9b8-f219-46ba-a7b5-f4ec92bdfa26' \
--header 'X-TENANT-KEY: e839651d-1765-4cd0-ba7f-547a4c20580f' \
--header 'X-TIME-ZONE: America/Mexico_City' \
--header 'X-API-KEY: sk_development_e0e47dfa_5146_40c2_b3a3_3055909a6b88' \
--data ''

Response

{
    "data": true,
    "succeeded": true,
    "message": "",
    "details": "",
    "httpStatusCode": 200
}