olx-api v1.0.1

olx-api

A module to access the OLX API resources.

For API documentation, check out the developer pages: https://developer.olx.ro/ro

:cloud: Installation

# Using npm
npm install --save olx-api

# Using yarn
yarn add olx-api

:clipboard: Example

const OlxApi = require("olx-api")

const client = new OlxApi(
    // e.g. https://www.olx.ro/api
    process.env.OLX_HOST,
    // your client id
    process.env.CLIENT_ID,
    // your client secret
    process.env.CLIENT_SECRET
)

// 1. Get the tokens
client.getTokens("client_credentials").then(() => {
    // 2. Access the APIs
    return client.get("/partner/cities")
}).then(cities => {
    console.log(cities)
    // { data:
    //    [ { id: 1,
    //        region_id: 46,
    //        name: 'Bucuresti',
    //        county: 'Bucuresti',
    //        municipality: '',
    //        latitude: 44.43783,
    //        longitude: 26.09464 },
    //      { id: 24485,
    //        region_id: 46,
    //        name: '1 Decembrie',
    //        county: 'Bucuresti - Ilfov',
    //        municipality: '',
    //        latitude: 44.63032,
    //        longitude: 25.99666 },
    //      ... ] }
}).catch(console.error)

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:

:memo: Documentation

OlxApi(host, clientId, clientSecret)

Initialize the instance of the OlxApi class.

Params

• String host: The OLX host (e.g. https://www.olx.ro/api).
• String clientId: Your application client id.
• String clientSecret: Your application client secret.

Return

• OlxApi The OlxApi instance.

getTokens(grantType)

Get and set the authentication tokens in the instance.

Params

• String grantType: One of the following:
  • authorization_code
  • client_credentials
  • refresh_token

Return

• Object An object containing the tokens or other authentication data.

post(path, data)

Make a POST request.

Params

• String path: The API path.
• Object data: The POST data.

Return

• Object The API response.

get(path)

Make a GET request.

Params

• String path: The API path.

Return

• Object The API response.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:scroll: License

MIT © Bloggify