API Pública de Ora

Documentos de la API 

La documentación completa de las llamadas API está disponible aquí => https://api.ora.pm

La comunidad de desarrolladores de Ora 

Únete a nosotros en http://spectrum.chat/ora/public-api para ayuda sobre la API, sugerencias, o simplemente para compartir con la comunidad en qué estás trabajando.

Crea una aplicación Ora

Para utilizar la API, deberás crear una aplicación dentro de una Organización en Ora.
1. Navega a <Tu Organización> / Preferences (Preferencias)

2. Luego, ve a la sección de Applications (Aplicaciones) y haz clic en el botón Create an App (Crea una App)

3. Completa la información requerida y haz clic en el botón Create App (Crear aplicación) Ten en cuenta que si deseas probar nuestra API utilizando la interfaz en https://api.ora.pm deberás configurar el URI de redireccionamiento de tu aplicación a https://api.ora.pm/swaggerui/oauth2-redirect.html

4. Después de crear tu aplicación, podrás expandirla desde el botón de flecha a la derecha de tu pantalla. Cuando la expandas, verás tu client_id y tu client_secret.

Probando tu App

1. Ya que tenemos tu aplicación creada, podemos probar algunas llamadas de API en https://api.ora.pm

Navega a la URL de la API. Luego haz clic en el botón Authorize (Autorizar) en el lado izquierdo de la página.

2. En el modo de autorización, después de colocar el ID de cliente y el Secreto de Cliente de tu aplicación, haz clic en Authorize (Autorizar)

3. Luego, se te dirigirá a la página de Ora donde el usuario actual debe otorgar permisos a tu aplicación.

    4. Después de eso, se te redirigirá a la página API, donde, si todo fue exitoso, iniciarás sesión y podrás probar las llamadas API. Permite, por ejemplo, probar si todo funciona normalmente obteniendo los proyectos del usuario actualmente registrado. Sigue estos pasos para hacerlo:
    - Expande la pestaña de Proyectos
    - Haz clic en el endpoint de Proyectos
    - Haz clic en el botón Try it Out (Probar) y luego presiona directamente el botón Execute (Ejecutar) ya que esta llamada no requiere ningún parámetro
    !Listo! En la sección de respuesta, podrás ver la respuesta de la solicitud.

Implementa el flujo OAuth2 

La URL autorizada de Ora es:https://ora.pm/autorize

1. Las cosas que tendrá que pasar a nuestra URL de autorización como parámetros son:

  • client_id: Tu ID de cliente para la aplicación
  • redirect_uri: Tu Uri de redirección para la aplicación 
  • response_type: Código 
  • state: Opcional (devuelto a tu redirect_uri)

URL Ejemplo: https://ora.pm/authorize?response_type=code&client_id=fYL8JzMW3TdawAfFsjUrpSrM5bFC9qiNnh4zigwiKJo3DsFs&redirect_uri=https:%2F%2Fapi.ora.pm%2Fswaggerui%2Foauth2-redirect.html&state=TW9uIERlYyAyMyAyMDE5IDE3OjUxOjM2IEdNVCswMjAwIChFYXN0ZXJuIEV1cm9wZWFuIFN0YW5kYXJkIFRpbWUp&realm=

2. Después de que el usuario que sigue tu enlace autorice a tu aplicación a tener acceso a su perfil, recibirás como parámetros de URL, el state (estado) que pasaste y el código generado que necesitarás para completar el segundo paso del proceso de OAuth.

Token de URL de Ora: https://api.ora.pm/oauth/token

Para obtener acceso a nuestra API, deberás enviar una solicitud POST a nuestro token de URL con un contenido que incluya estos parámetros en formato JSON:
  • client_id:  Tu ID de cliente para la aplicación
  • client_secret: Tu client secret para la aplicación
  • code:  El código que recibió en el paso anterior
  • redirect_uri : Tu Uri de redirección para la aplicación 
  • grant_type: Tu código de autorización ("authorization_code")

Si todos los datos que has enviado son válidos, recibirás un JSON, con estos datos incluídos:

  • access_token: El token que usarás para realizar solicitudes a nuestra API. Tendrás que pasarlo como encabezado en este formato{"Authorization" : "Bearer {your_token}"}    
  • refresh_token: Este token deberás pasar a la URL del token de nuestra API con el código de autorización (grant_type): "refresh_token" para obtener un nuevo access_token cuando este expire.

Aquí se puede encontrar un ejemplo del proceso de OAuth: https://github.com/codemotionapps/flask-api-example

Si tiene alguna pregunta, no dudes en consultarnos en hi@ora.pm 

Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.

Still need help? Contact Us Contact Us