API docs by Redocly

Bidassist Public Api (1.1)

Download OpenAPI specification:Download

In order to use the public Api's one must procure the API key from bidassist. Your Api key is your secret key and must not be shared with anyone. The API key needs to be passed as value of header named as X-OFG-TOKEN , with every request that is sent to Bidassist Public Api's.

  • For accessing Tender, Tender Result, Document, Filter Api's use - https://partner-api.bidassist.in/api/public/v1
  • For accessing Company Api's use - https://partner-api.bidassist.in/api/v1/client

    • Tender

    API's to access tenders

    Search tenders by preference

    Search tenders, using the preferences set for Tender

    Request Body schema: application/json

    Request payload to search tenders by preference

    preferenceId
    string

    User preference id (If provided, can be fetched using /filters api), to search tenders.

    sortType
    string
    Value: "RELEVANCE"

    The tenders will be sorted using the provided sort type

    sortValue
    string
    Enum: "ASC" "DESC"

    Ascending or descending sorting to be applied on tenders. Use ASC (for ascending), DESC (for descending)

    pageNumber
    required
    integer

    Page number of the response to be searched.

    pageSize
    required
    integer

    Page size of response to be searched. Should be less than or equals to 20

    object

    Additional filters for the search.Filter values should be passed as range of date/values.

    Responses

    Request samples

    Content type
    application/json
    {
    • "preferenceId": "string",
    • "sortType": "RELEVANCE",
    • "sortValue": "ASC",
    • "pageNumber": 0,
    • "pageSize": 0,
    • "filters": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "data": {
      },
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }

    Get tender details using tender key

    The tender can be fetched using its unique tender key. The response for /tender-result/search api, will also contain the direct url for this api in tenderCompleteInfoUrl field for every tender

    path Parameters
    tenderKey
    required
    string

    This is a key unique to every tender.

    Responses

    Response samples

    Content type
    application/json
    {
    • "data": {
      },
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }

    Tender Result

    API's to access tender results

    Search tender results by preference

    Search tender results , using the preferences set for Tender Result

    Request Body schema: application/json

    Request payload to search tender results by preference

    preferenceId
    string

    User preference id (If provided, can be fetched using filters api), to search tender results.

    sortType
    string
    Value: "RELEVANCE"

    The tender results in response will be sorted using the provided sort type .

    sortValue
    string
    Enum: "ASC" "DESC"

    Ascending or descending sorting to be applied on tenders. Use ASC (for ascending), DESC (for descending)

    pageNumber
    required
    integer

    Page number of the response to be searched.

    pageSize
    required
    integer

    Page size of response to be searched. Should be less than 20

    object

    Additional filters for the search. Filter values should be passed as range of date/values.

    Responses

    Request samples

    Content type
    application/json
    {
    • "preferenceId": "string",
    • "sortType": "RELEVANCE",
    • "sortValue": "ASC",
    • "pageNumber": 0,
    • "pageSize": 0,
    • "filters": {
      }
    }

    Response samples

    Content type
    application/json
    {
    • "data": {
      },
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }

    Get tender result using tender result key

    The tender result can be fetched using tender result key. The response for /tender/search api, will also contain the direct url for this api in tenderResultCompleteInfoUrl field for every tender

    path Parameters
    tenderResultKey
    required
    string

    This is a key unique to every tender result.

    Responses

    Response samples

    Content type
    application/json
    {
    • "data": {
      },
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }

    Document

    API's to access documents

    Download Document

    This api will obtain direct download link for a tender or tender result document using document key. The provided download link , will be valid for 7 days. (may change in future.)

    path Parameters
    documentKey
    required
    string

    The response from tender/search ,tender-result/search, tender-result/detail/{tenderKey},tender-result/detail/{tenderResultKey} will contain a documents collection. The direct download link can be fetched using this api, from 'documentKey' field for each of the document objects in documents collection.

    Responses

    Response samples

    Content type
    application/json
    {
    • "data": "string",
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }

    Filter

    APIs to access filters (if preferenceId is provided), which will be used to fetch tenders and tender results by preferenceId.

    getAllFilters

    Fetch all filters for the account associated with your API key.

    Responses

    Response samples

    Content type
    application/json
    {
    • "data": [
      ],
    • "success": true,
    • "errorMessage": "string",
    • "errorCode": "string",
    • "meta": { }
    }