GET/Token

Recupere de forma segura los tokens registrados. Puede realizar una recuperación detallada de un solo token o una recuperación de toda la lista de tokens.

Cuando la opción Secure Data Transmission está habilitada, los datos de respuesta se transmiten cifrados con AES-256.

Información Básica

method

string

requerido

GET

url

string

requerido

https://rest-api.argosidentity.com/v3/submission/tokens

Configuración de Seguridad

Transmisión Cifrada

Cuando Secure Data Transmission está habilitada, todos los datos de respuesta están protegidos con cifrado AES-256.

Método de cifrado: AES-256
Cobertura: Datos de respuesta
Compatibilidad: Mismo método de cifrado/descifrado que POST/submission, PATCH/submission, DELETE/submission, Webhook
Opciones de Transferencia Segura de Datos

Autenticación

x-api-key

string

requerido

Establezca su clave API del proyecto.

x-api-key: {{YOUR_API_KEY}}

Tipos de Recuperacion de Tokens

Recuperacion individual

Recuperacion detallada de un tokenId específico (1 por solicitud)

Recuperacion de lista

Recuperacion de toda la lista de tokens: 10,000 por solicitud
Cuando los tokenId registrados superan 10,000, se proporcionan campos de paginación (‘nextPageKeyId’, ‘nextPageKeyTime’)

Recuperacion de conteo total

Recuperar el conteo total de tokens registrados (conteo total N por solicitud)

Parámetros de Solicitud

Parámetros de Consulta

tokenId

String

ID de token específico

Cuando se proporciona: Recuperacion detallada de un solo token
Cuando no se proporciona: Recuperacion de toda la lista de tokens

type

String

count

Cuando se proporciona: Recuperar solo el conteo total de tokens registrados
Cuando no se proporciona: Proporcionar tokens registrados, estado de expiración y conteo

GET /submission/tokens?tokenId=user001a

Respuesta

Respuesta Exitosa (200)

Recuperacion de token individual
Recuperacion de lista completa
Recuperacion de conteo total

success

Boolean

requerido

Estado de éxito de la recuperación

tokenId

String

requerido

ID del token recuperado

data

Object

requerido

Datos del token

Mostrar data properties

tokenId

String

ID del token

updateTime

String

Última hora de actualización (formato ISO 8601)

expired

Boolean

[true, false]

{
  "success": true,
  "tokenId": "user001a",
  "data": {
    "tokenId": "user001a",
    "updateTime": "2024-01-15T10:30:45.123Z"
  }
}

success

Boolean

requerido

Estado de éxito de la recuperación

tokenId

Array<String>

requerido

Lista de IDs de tokens

data

Array<Object>

requerido

Array de datos de tokens

Mostrar data array properties

tokenId

String

ID del token

updateTime

String

Última hora de actualización (formato ISO 8601)

expired

Boolean

[true, false]

count

Number

requerido

Conteo total de tokens

nextPageKey

Object

requerido

Objeto de clave de paginación

Mostrar nextPageKey array properties

String

ID de clave de paginación

time

String

Tiempo de clave de paginación

{
  "success": true,
  "tokenId": ["user001a", "api.key.01", "token-123-abc"],
  "data": [
    {
      "tokenId": "user001a",
      "updateTime": "2024-01-15T10:30:45.123Z"
    },
    {
      "tokenId": "api.key.01",
      "updateTime": "2024-01-15T09:15:30.456Z"
    },
    {
      "tokenId": "token-123-abc",
      "updateTime": "2024-01-15T08:45:12.789Z"
    }
  ],
  "count": 3,
	"nextPageKey" : {
	  "id": "sample.id.01",
	  "time": "2024-01-15T08:45:12.792Z"
	}
}

success

Boolean

requerido

Estado de éxito de la recuperación

totalCount

Number

requerido

Conteo total de tokens registrados

{
  "success": true,
  "totalCount": 4991
}

Puede usar el valor data[‘expired’] para verificar cuáles tokens han expirado entre los enviados anteriormente y utilizarlo para operaciones DELETE-token.

Respuesta de Error (400/500)

errorCode

String

requerido

Código de error

errorMessage

String

requerido

Mensaje de error

{
  "errorCode": "token_not_found",
  "errorMessage": "Token not found."
}

Consideraciones de Seguridad

Protección de Datos

La recuperación de tokens puede contener información sensible. Considere habilitar la opción de cifrado para seguridad en entornos de producción.

Transmisión cifrada: Cifrado de datos de respuesta mediante AES-256
Control de acceso: Restricción de acceso a nivel de proyecto mediante claves API
Pre-validación: Recuperacion API posible independientemente del estado de activación de la opción

Política de Tokens

Pool de Tokens: Gestione hasta 100,000 tokens por PID Alcance de recuperación: Solo puede recuperar tokens dentro del alcance del proyecto

Códigos de Error

Errores Comunes

Error Code	HTTP Status	Descripción
invalid_payload	400	Payload de solicitud faltante o error de formato
invalid_path	400	Método HTTP no soportado
invalid_project	400	ID de proyecto faltante o clave API inválida
invalid_query_parameters	400	Parámetros de consulta faltantes o error de formato
invalid_order	400	Error de formato en el parámetro de orden de consulta
internal_server_error	500	Error interno del servidor

Errores Relacionados con Tokens

Error Code	HTTP Status	Descripción
invalid_token_id	400	ID de token faltante, valor vacío o no es un array
invalid_token_id_format	400	Violación de regla de formato de ID de token
invalid_token_id_type	400	El ID de token no es una cadena
invalid_token_id_length	400	Longitud del ID de token fuera del rango de 8-64 caracteres
invalid_token_id_whitespace	400	El ID de token contiene caracteres de espacio en blanco
invalid_token_id_characters	400	El ID de token contiene caracteres no permitidos
invalid_token_id_start	400	El ID de token no comienza con letra/número
invalid_token_id_end	400	El ID de token no termina con letra/número
request_token_limit_exceeded	400	Límite de conteo de tokens por solicitud excedido (500)
token_limit_exceeded	400	Limite total de tokens del proyecto excedido (100,000)
token_id_not_found	400	El token solicitado no existe en el pool
token_id_details_not_found	400	Fallo en la recuperación de detalles del token
delete_token_limit_exceeded	400	Conteo de solicitud de eliminación masiva basada en tiempo excedido (5000)

Ejemplos de Uso

Verificar toda la lista de tokens

Primero, recupere todos los tokens registrados en el proyecto.

curl -X GET 'https://rest-api.argosidentity.com/v3/submission/tokens' \
  -H 'x-api-key: YOUR_API_KEY'

Puede verificar el conteo total de tokens a través del campo count en la respuesta.

Recuperar detalles de un token específico

Recupere información detallada de un token específico.

curl -X GET 'https://rest-api.argosidentity.com/v3/submission/tokens?tokenId=user001a' \
  -H 'x-api-key: YOUR_API_KEY'

Puede verificar la última hora de actualización del token a través de updateTime.

En entornos cifrados, los datos de respuesta también se proporcionan cifrados.
Se requiere procesamiento de descifrado para estos datos.
Para métodos de cifrado y descifrado, consulte Cifrado y Descifrado de Datos.

Descripción General

Referencia API

Información Básica

Configuración de Seguridad

Transmisión Cifrada

Autenticación

Tipos de Recuperacion de Tokens

Parámetros de Solicitud

Parámetros de Consulta

Respuesta

Respuesta Exitosa (200)

Respuesta de Error (400/500)

Consideraciones de Seguridad

Protección de Datos

Política de Tokens

Códigos de Error

Errores Comunes

Errores Relacionados con Tokens

Ejemplos de Uso

Descripción General

Referencia API

​Información Básica

​Configuración de Seguridad

​Transmisión Cifrada

​Autenticación

​Tipos de Recuperacion de Tokens

​Parámetros de Solicitud

​Parámetros de Consulta

​Respuesta

​Respuesta Exitosa (200)

​Respuesta de Error (400/500)

​Consideraciones de Seguridad

​Protección de Datos

​Política de Tokens

​Códigos de Error

​Errores Comunes

​Errores Relacionados con Tokens

​Ejemplos de Uso

Información Básica

Configuración de Seguridad

Transmisión Cifrada

Autenticación

Tipos de Recuperacion de Tokens

Parámetros de Solicitud

Parámetros de Consulta

Respuesta

Respuesta Exitosa (200)

Respuesta de Error (400/500)

Consideraciones de Seguridad

Protección de Datos

Política de Tokens

Códigos de Error

Errores Comunes

Errores Relacionados con Tokens

Ejemplos de Uso