API de la plataforma de taxonomía abierta

Los mercados laborales son diversos y cambian rápidamente, por lo que una taxonomía útil debe poder localizarse y adaptarse de manera transparente. Conoce más sobre la API que impulsa nuestra plataforma de taxonomía abierta.

Descripción general y formato

La Plataforma de taxonomía abierta La API proporciona acceso seguro a modelos de taxonomía, ocupaciones, habilidades y sus respectivos grupos, lo que permite una integración fluida con sus aplicaciones. La URL base para todas las solicitudes de la API es https://taxonomy.tabiya.tech/taxonomy/api-doc/swagger/. Para garantizar una comunicación estandarizada, todas las solicitudes y respuestas (excepto las cargas de archivos) utilizan el formato JSON, lo que facilita la integración con cualquier entorno de programación moderno.

Credenciales y autenticación

Prerrequisitos

Antes de que pueda integrarse con las API, debe obtener credenciales de los administradores de la plataforma. Solicite credenciales a través de la dirección de correo electrónico dedicada en esta página. Según el método de autenticación que elija, recibirá:

• Claves de API: Una única X-API-Key

• OAuth M2M: Una URL del servidor de autorización, ID de cliente, y Secreto de cliente

Prefijos de ruta de la API

Todas las API de socios usan el siguiente prefijo de ruta:

• /api/partner para claves de API

• /api/app Para tokens JWT recibidos mediante OAuth M2M.

Métodos de autenticación

Admitimos dos métodos de autenticación. Elija el que se ajuste a sus requisitos de seguridad.

Claves de API

Las claves de API proporcionan un mecanismo de autenticación sencillo, adecuado para integraciones básicas.

Uso

Incluya la clave de API en cada solicitud usando el X-API-Key encabezado HTTP.

Ejemplo:-

curl -X GET \\
  https://taxonomy.tabiya.tech/api/partner/info \\
  -H "X-API-Key: YOUR_API_KEY"

OAuth 2.0 de máquina a máquina (M2M)

OAuth 2.0 de máquina a máquina es el método recomendado para una comunicación segura y automatizada entre servicios mediante tokens de acceso de corta duración

Paso 1

Envíe una solicitud HTTP POST a URL del servidor de autorización usando el ID de cliente y Secreto de cliente.

Ejemplo

curl -X POST YOUR_AUTHORIZATION_SERVER_URL \\
     -H "Content-Type: application/x-www-form-urlencoded" \\
     -d "grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET"

El servidor de autorización responde con un token de acceso:

{
   "access_token": "YOUR_ACCESS_TOKEN",
   "token_type": "Bearer",
   "expires_in": 3600
}

Para más detalles, consulte la documentación sobre el token de autenticación en la parte de intercambio de credenciales de cliente por token de acceso.

• https://docs.aws.amazon.com/cognito/latest/developerguide/token-endpoint.html#post-token-positive-exchanging-client-credentials-for-an-access-token-in-request-body

Paso 2

Envíe una solicitud a la API con el token de acceso del resultado anterior.

curl -X GET \\
   https://taxonomy.tabiya.tech/api/app/info \\
   -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Para más detalles, consulte la Ámbitos, M2M y servidores de recursos documentación en AWS.

Acceso directo a la especificación OpenAPI

Hay dos métodos de acceso disponibles para las especificaciones de la API. El método principal es a través de la documentación interactiva Swagger UI, que permite explorar y probar en vivo todos los endpoints. Fundamentalmente, para los desarrolladores que buscan configurar rápidamente sus clientes, se proporciona un enlace directo e independiente al archivo de especificación JSON de OpenAPI v3. Este enlace es esencial para los desarrolladores que desean importar toda la definición de la API en herramientas como Postman o Insomnia (usando la opción Importar > Enlace), acelerando la configuración mediante la generación automática de todas las definiciones de endpoints, parámetros y esquemas:

• Enlace de la especificación OpenAPI: https://taxonomy.tabiya.tech/api-doc/swagger/tabiya-api.json

• Enlace de Swagger UI: https://taxonomy.tabiya.tech/api-doc/swagger/

• Enlace de ReDoc UI: https://taxonomy.tabiya.tech/api-doc/redoc/