Primeros pasos

Configuración: Después de tener instalado el API de Delfín Software, al momento de ingresar la URL de acceso en un navegador de internet, debemos visualizar la siguiente página de configuración, que permite asignar las rutas donde se encuentra instalado el sistema Delfín Software y su base de datos.

Visualizar listado de entidades disponibles: Para visualizar el listado de entidades disponibles que pueden ser consultadas a través del API, se debe adicionar a la URL de acceso la siguiente ruta /v1/OrganizacionOData.svc, ejemplo:

http://(URLAcceso)/v1/OrganizacionOData.svc

El resultado de esta solicitud es retornando por defecto en formato XML, para cambiar el resultado a formato JSON y como se hará de ahora en adelante para todos los ejemplos, se debe adicionar a la solicitud el queryString $format=json de la siguiente forma:

http://(URLAcceso)/v1/OrganizacionOData.svc/?$format=json

Esta información se visualizará distinto depende del navegador o los plugin instalados dentro del navegador.

Visualizar metadata: Para visualizar la estructura de propiedades de todas las entidades con sus claves primarias, se debe adicionar a la URL de acceso la siguiente ruta /v1/OrganizacionOData.svc/$metadata, ejemplo:

http://<URLAcceso>/v1/OrganizacionOData.svc/$metadata

Esta información siempre será visualizada en formato XML.