@stacc/services-ambita-realty
v2.7.3
Published
An API that proxies the Ambita Realty API
Downloads
100
Readme
Stacc Ambita Realty Proxy API
An API that proxies the Ambita Realty API
Requirements
To run and try out this API locally, a .env file must be included with the correct credentials:
API_URL=<API_URL>
AUTH_URL=<AUTH_URL
AMBITA_CLIENT_ID=<AMBITA_CLIENT_ID>
AMBITA_CLIENT_SECRET=<AMBITA_CLIENT_SECRET>
AMBITA_USERNAME=<AMBITA_USERNAME>
AMBITA_PASSWORD=<AMBITA_PASSWORD>
After this is setup, run the following command at the project's root:
$ npm install && npm run dev
Try out the API locally with REST client (Visual Studio Code)
- Install a REST client for your IDE
- VSCode: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
- Add a settings.json file to your .vscode folder and include the following:
{ "rest-client.environmentVariables": { "$shared":{ "nin1": "<enter your nin here>", "nin2": "<enter your nin here>" }, "local": { }, "production": { } } }
- !! Always make sure to not commit sensitive personal data to the VCS !!
$ npm run dev
- You should now be abvle to run the requests in the src/requests folder.
For other IDE's, follow the documentation and makes sure to .gitignore any files containing sensitive information:
- Webstorm: https://www.jetbrains.com/help/webstorm/exploring-http-syntax.html#using_request_vars