Comenzar con las APIs
Siga esta guía para iniciar sesión en el portal, crear su aplicación, suscribirse a las APIs y realizar su primera llamada.
1. Conectarse al portal API
Los portales API de STEF le permiten suscribirse a las APIs de STEF mediante aplicaciones consumidoras personales o compartidas dentro de un equipo.
Como empleado de STEF, no es necesario solicitar la creación de una cuenta para acceder a los portales.
Acceda al portal deseado y, durante la autenticación, haga clic en el botón Iniciar sesión como empleado de STEF.
Consulte la guía de instancias APIM para obtener la lista de portales disponibles y sus usos.
Para poder crear una aplicación consumidora compartida con su equipo, debe solicitar la creación de un equipo mediante un ticket JIRA APIM, indicando el nombre del equipo y el/los portal(es) de destino.
2. Crear una aplicación
Para consumir una API, primero debe disponer de una aplicación consumidora. Al crearla, se genera una credential, que identifica su aplicación durante una llamada.
- Haga clic en su perfil en la parte superior derecha del portal
- Haga clic en el botón Applications
- Haga clic en el botón New application
- Indique el nombre y la descripción de su aplicación
- Para compartir esta aplicación con su equipo, marque This is a team owned application y seleccione el equipo deseado
- Haga clic en el botón Create application
- Anote la credential generada durante la creación
3. Suscribirse a una API
Una aplicación consumidora puede suscribirse a una o varias APIs en función de sus necesidades.
Use el menú APIs para consultar el catálogo de APIs de STEF disponibles.
Navegue hasta los productos que le interesen para mostrar la documentación técnica para desarrolladores, que presenta para cada API:
- Las distintas operaciones compatibles
- La definición de los objetos de entrada y salida
- Ejemplos de código para consumirlas
Para suscribirse a una API:
- Abra el detalle de una API
- Haga clic en Use this API en la parte superior derecha
- Haga clic en el botón Register asociado a la aplicación que desea suscribir
La suscripción deberá ser validada posteriormente por STEF; para ello, póngase en contacto con su referente de STEF IT.
Como una aplicación puede suscribirse a varias APIs, repita el procedimiento de suscripción para cada API que desee utilizar.
Consultar y gestionar sus suscripciones
Para consultar las suscripciones de una aplicación, haga clic en su perfil en la parte superior izquierda y después en Applications; a continuación, haga clic en el nombre de su aplicación. En la pestaña APIs, que se muestra automáticamente, encontrará la lista de sus suscripciones y su estado.
También puede solicitar la suscripción a otras APIs directamente desde este menú, haciendo clic en + API.
4. Consumir una API
Todas las invocaciones a APIs de STEF pasan por la Gateway API de STEF para aplicar las reglas de seguridad de acceso, garantizar la protección de los servicios backend del sistema de información de STEF y recopilar estadísticas de invocación.
Las Gateway API están disponibles en las siguientes URL:
- Producción: https://api-suitelogi.stef.com
- Cualificación: https://api-suitelogi-qua.stef.com/
Para consumir una API y respetar las reglas de seguridad de acceso, añada a la solicitud el encabezado HTTP X-STEF-Client-Id, con el valor de la credential de su aplicación consumidora.
La documentación técnica para desarrolladores ofrece, para cada API publicada en la plataforma, ejemplos de código para invocar la Gateway API desde distintos lenguajes: Shell, Python, Node.js, JavaScript, Go, Java, C# y Ruby.
Ejemplo de invocación
curl -X GET "https://api.stef.com/v1/transport/orders" \
-H "X-STEF-Client-Id: <YOUR_APPLICATION_SECRET>" \
-H "Content-Type: application/json"
Además de los ejemplos de código, la documentación técnica para desarrolladores propone formularios para invocar las APIs directamente desde el portal en modo interactivo mediante el botón Try it!.