...
- Installed Application - Android, iOS, and desktop applications. These use a one-time pin or QRCode to authorise a grant request.
- Web Application - Web application assumed to be able to keep a secret (PHP, Ruby, Perl, etc). These use a redirection with a token to authorise a grant request.
- Service Application - These are not run from an end-user and thus do not require a grant. The client's secret is used to obtain an access_token.
| Info |
|---|
| An application can only have one type. If your application requires multiple types, please register multiple API applications through Accelo as appropriate. |
Getting familiar with the basics
...
_limit- The max number of resources to return. This is not the number of resources returned. Default: 10, Max: 50_offset - the resource to return from. Default: 0
_limit paramater in conjunction with _page to alter the number of items returned per page. Be sure that you include the limit in all subsequent page requests, otherwise, you will receive inaccurate page data....
- Optional Fields: include optional fields from a given resource.
- For Example:
/companies/12.json?_fields=website,phone - Would return the company's default fields including the company's website and phone number.
- For Example:
- Linked Resources: resources linked to other resources
- For example:
/companies/12.json?_fields=status(),contact(status(color)) - would return the companies default fields, including linked resources status and contact. It will also return the linked contacts status with optional extra field color.
- For example:
If you would like all optional fields, please use the "_ALL" keyword. For example, companies/12.json?_fields=_ALL would return all fields for company #12. You can also request all fields for objects by nesting the "_ALL" keyword. For example, companies/12.json?_fields=_ALL,contact(_ALL) would return all fields on the linked contact resource. The all keyword will not return linked resources.
Linked resources and optional fields can be found in detail on the endpoints resource page.
...
We understand that certain types of requests are not always available to the client. In response to this we allow you to override the request method using the _method paramater parameter. For example, the following requests are all identical. Each returns the response as XML.
| Code Block | ||||
|---|---|---|---|---|
| ||||
DELETE /companies/10.xml GET /companies/10.xml?_method=delete POST /companies/10.xml?_method=delete |
...
What's Next?
Now that you have dabbled in the basics of the API, it is time that you checkout OAuth 2.0 Authentication. This will introduce you to grants, bearer tokens and application specific application authorization flows.