...
| Note |
|---|
The Crittah API is only available in the Enterprise version of Crittah. If you would like to upgrade from Standard or Lite to use this feature please contact sales on our website (www.crittah.com) |
Getting Started
| Table of Contents |
|---|
...
The standard methods are:
| Method | Action performed |
|---|---|
| GET | Retrieves data from a resource |
| DELETE | Deletes the data from a resource |
| POST | Creates a new resource or updates the supplied data for an existing resource. also used to post complex data structures for searches. |
| PUT | Overwrites the resource with the data you provided |
Tools
To test the Crittah API you can use a simple command line tool called "cURL" (As in "Call URL") . cURL can or a more user friendly application called Postman.
Postman
Postman can be downloaded from https://www.getpostman.com/
cURL
cURL can be used on Windows, Linux and UNIX machines to perform your testing with the Crittah API. Curl is usually installed on Mac, Linux and UNIX systems by default. If you are running windows then you can download and install cURL from here.
...
There are complete example calls in the documentation of each REST web service provided. These example class will show you how to user the credentials you have setup above when access the Crittah API.
Relationship diagram
The following digram shows the relationship of entities within Crittah. Tis can be used to understand the relationship between customers, contacts, drivers, jobs, shifts etc. You can use this in conjunction with the API documentation to update and retrieve information from Crittah.
| Gliffy | ||||
|---|---|---|---|---|
|
REST documentation
| Page Tree | ||
|---|---|---|
|