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 ser localizable y adaptable de forma transparente. Conozca más sobre la API que impulsa nuestra plataforma de taxonomía abierta.

Resumen y formato

El Plataforma de taxonomía abierta La API proporciona acceso seguro a modelos de taxonomía, ocupaciones, habilidades y sus respectivos grupos, permitiendo 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 subidas de archivos) utilizan el formato JSON, lo que facilita la integración con cualquier entorno de programación moderno.

Credenciales y autenticación

Requisitos previos

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

• Claves API: Un X-API-Key

• M2M OAuth: Un 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 API

• /api/app Para tokens JWT recibidos vía M2M OAuth.

Métodos de autenticación

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

Claves API

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

Uso

Incluya la clave 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"

Machine to Machine (M2M) OAuth 2.0

Machine to Machine OAuth 2.0 es el método recomendado para la comunicación segura y automatizada entre servicios usando tokens de acceso de corta duración

Paso 1

Envíe un POST solicitud HTTP a la 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 información consulte la documentación del 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, vea la documentación de Scopes, M2M y servidores de recursos 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. De forma crucial, para los desarrolladores que desean configurar rápidamente sus clientes, se proporciona un enlace directo y autónomo al archivo de especificación OpenAPI v3 en formato JSON. Este enlace es esencial para los desarrolladores que quieran importar la definición completa de la API en herramientas como Postman o Insomnia (usando la opción Importar > Enlace), acelerando la configuración al generar automáticamente 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/