We have included below some Open Source resources to help get you started right away using Smile API!
API Specifications
Note
You can download a copy of Smile API's specifications in Github. If you have git installed, you can clone the repository or run the following command:
git clone https://github.com/SmileAPI/smile-openapi
The specification document is in YAML format, following Open API Specification version 3.0.0. You can also download offline copies of our Developer Documentation in markdown format, under the /docs subdirectory.
Postman Collection
Note
Download Smile API's Postman Collection in Github. If you have git installed, you can clone the repository or run the following command:
git clone https://github.com/SmileAPI/smile-openapi
You can start reviewing and testing our APIs easily by downloading our Postman collection in JSON format and importing it into Postman.
Using the Postman Collection
- Download the "postman-collection-(v#).json" document from our Github repository.
- If you haven't done so, visit Postman and create an account, or download their free desktop client.
- Open Postman and select a Workspace.
- Import the Postman collection.
- Make sure you are able to authenticate by entering your API key and API secret.
- That's it! You can now start testing Smile's APIs!