This article is an introduction to DevelopmentAid's external API for member companies that allows automatic job posting.
What Is an API?
API stands for “Application Programming Interface”. The API is a program that functions in the background between the user and the website itself. You may already be constantly utilizing an API without even realizing it.
The main principle to understand about an API is that it is discrete. It gathers a small amount of data from the user, but will not leave their device exposed. It will also access data from the website, but will similarly not expose it. APIs just take what they need, and then bring back what is required
API for Job Posting on DevelopmentAid
The DevelopmentAid APIs will facilitate job posting for your organization. To use the API, authorization with an api-key is required, which can be obtained here.
After an API token has been generated, an IT specialist can implement our programming interface to streamline your recruitment processes.
At this time, DevelopmentAid provides you with dictionary resources for posting jobs and funding opportunities. Within this context, you can use our APIs to perform four basic CRUD functions:
- Create
- Read
- Update
- Delete
For example, you can create jobs, read or retrieve job types, update job information, and delete them.
These CRUD functions can be translated into four HTTP methods:
- POST
- GET
- PUT
- DEL
The table above is an example of Jobs APIs and their relationship with CRUD and HTTP methods. The {jobId} is a parameter that you can change to specify the object that you are requesting.
Response
Responses define the HTTP status code and data returned in a response body and headers. Whether it was a success or failure, you will always receive a response that contains a status code and payload.
A full list with all responses is available in our documentation. The left side contains the numerical 3 digit status codes and the right side contains a brief description of what it means.
A rule of thumb is that
- 2XX — success
- 4XX — client error
- 5XX — server error
In other words, if you successfully created a job using DevelopmentAid API, then the status code returned will be 200. Else if you made a mistake (whether it’s unauthorized, wrong attributes, etc) then you will receive 4XX. And finally, if you did everything right but received a 5XX then there is an issue with DevelopmentAid.
Full documentation on our external API can be found here: DOCUMENTATION
If you have questions regarding our APIs, you are welcome to send an email to DevelopmentAid Tech Support.