Introducción

curl -i -X GET 'https://dev.hrider.net/api/v1' \
-H 'authorization: bearer oC0aGOzvwLSHJaDQ5kJv2bavrtmjkkYRAnb8BVoN'
                    

    {
        "_embedded":{
                "company":{
                    "id":8113,
                    "name":"ACME SOLUTIONS"
                },
                "position":{
                    "id":8348,
                    "code":"W.DESIGNER",
                    "name":"WEB DESIGNER"
                },
                "supervisor":{
                    "id":9121,
                    "code":"EMP001", 
                    "email":"[email protected]", 
                    "firstName":"ROGER", 
                    "lastName":"OLIVER", 
                    "photo":"12345"
                },
                "clients":[]},
        "_links":{
                "self":{"href":"/v1/companies/8113/employees/12430"},
                "company":{"href":"/v1/companies/8113"},
                "position":{"href":"/v1/companies/8113/employees/12430/position"},
                "supervisor":{"href":"/v1/companies/8113/employees/12430/supervisor"},
                "subordinates":{"href":"/v1/companies/8113/employees/12430/subordinates"},
                "clients":{"href":"/v1/companies/8113/employees/12430/clients"},
                "photo":{"href":"/v1/companies/8113/employees/12430/photo"},
                "photoContent":{"href":"/v1/companies/8113/employees/12430/photo?alt=media"}},
        "address":"7292 Dictum",
        "birthDate":"1976-01-04T23:00Z",
        "city":"San Antonio",
        "code":"EMP002",
        "country":"USA",
        "dateCreated":"2020-06-09T09:45Z",
        "dateModified":"2017-07-19T07:17Z",
        "email":"[email protected]",
        "externalId":null,
        "firstName":"LAWRENCE",
        "gender":"male",
        "hireDate":null,
        "id":12430,
        "lastName":"WISE",
        "nationalId":"",
        "phone":"1-541-754-3010",
        "phone2":"",
        "photo":153648986024067666,
        "postalCode":"47096",
        "province":""
}                        
                    

• El atributo _embedded contiene un resumen de cada uno de los objetos con los que el empleado se relaciona. En este caso incluye un resumen de los datos de su compañía, puesto de trabajo y supervisor actualmente asignado. El resto de objetos retornados por la API siguen la misma lógica.
• El atributo _links contiene enlaces a los recursos con los que se relaciona y, cuando el objeto relacionado puede existir de forma independiente, permite también establecer o eliminar la relación entre ellos. En el caso de un empleado, los enlaces son:

  Nombre	Tipo	Métodos	Descripción
  self	Recurso	GET	Enlace a si mismo
  company	Recurso	GET	Enlace a la compañía del empleado
  position	Relación	GET/PUT/DELETE	Enlace para establecer el puesto de trabajo del empleado
  supervisor	Relación	GET/PUT/DELETE	Enlace para establecer el supervisor del empleado
  subordinates	Relación	GET/PUT/DELETE	Enlace para establecer los subordinados del empleado
  clients	Relación	GET/PUT/DELETE	Enlace para establecer los clientes del empleado
  photo	Relación	GET/POST/DELETE	Enlace para obtener y subir la foto del empleado
  photoContent	Relación	GET	Enlace para obtener el contenido de la foto del empleado

  En general, el content-type de las peticiones POST para crear y actualizar recursos es application/json, para crear y eliminar relaciones entre recursos se utiliza text/uri-list con la lista de URIs (una por línea) de los recursos a relacionar. Puedes ver un ejemplo de como asignar a un administrador dos compañías aquí.
• Las fechas se expresan en formato UTC yyyy-MM-ddTHH:mmZ

curl -i -X GET 'https://dev.hrider.net/api/v1/companies/12345/employees/1234' \
        -H 'authorization: yourAuthAPIKey'

curl -i -X GET 'https://dev.hrider.net/api/v1/companies/12345/employees/external-id=5678' \ 
        -H 'authorization: yourAuthAPIKey'

curl -i -X GET 'https://dev.hrider.net/api/v1' -H 'authorization: bearer yourAPIKey'
                    

{
    "_embedded":null,
    "_links":{
            "self":"v1",
            "companies":{"href":"v1/companies"},
            "administrators":{"href":"v1/administrators"},
            "files":{"href":"v1/files"}
    }
}
                    

• companies. Enlace para trabajar con compañías.
• administrators. Enlace para trabajar con administradores.
• files. Enlace para trabajar con ficheros.

      
HTTP/2 404 
content-type: application/json
content-length: 93

{"code":"E001","status":404,"message":"Not found","description":"Employee '124301' not found"}