Glossary
Speak the language of Dealerware API!
Use this glossary to find definitions for common terms you may come across while using Dealerware API.
| TERM | DEFINITION |
|---|---|
| API | Application Programming Interface |
| API KEY | An API key acts as a secret authentication token as well as a unique identifier. |
| BOOLEAN | A binary variable, having two possible values called “true” and “false.”. |
| Client ID | A Client ID is a public identifier that is unique across all clients that the authorization server handles. |
| Client Secret | A Client Secret is a secret identifier known only to the application and the authorization server. |
| cURL | Client URL. A computer software project that provides a library and command-line utility often used for transferring data to interact with REST endpoints using various network protocols. |
| DELETE | The DELETE method deletes the specified resource. |
| DEPRECATION | A deprecated API is one that you are no longer recommended to use, due to changes in the API. While deprecated classes, methods, and fields are still implemented, they may be removed in future implementations, so you should not use them in new code, and if possible rewrite old code not to use them. |
| GET | The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. |
| ENDPOINT | The point of entry in a communication channel when two systems are interacting. It refers to touchpoints of the communication between an API and a server. |
| JSON | JavaScript Object Notation. A lightweight syntax containing objects and arrays, usually used (instead of XML) to return information from a REST API. |
| KPI | Key Performance Indicator |
| OpenAPI | The official name for the OpenAPI specification. The OpenAPI specification provides a set of properties that can be used to describe your REST API. When valid, the specification document can be used to create interactive documentation, generate client SDKs, run unit tests, and more. |
| POST | The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server. |
| PUT | The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server. |
| REST | Representational State Transfer |
| TELEMATICS | Telematics includes data about the location, behavior, status, maintenance status, compliance, and availability for vehicle and fleet management. |
| YAML | “YAML Ain’t No Markup Language.” A human-readable, space-sensitive syntax used in the OpenAPI specification document. |