Skip to content
Download OpenAPI description
Overview
Languages
Servers
Mock server
https://panorays-papi-v2-documentation.redocly.app/_mock/swagger
https://api.panoraysapp.com

Supplier

Use these routes to access and update your suppliers.

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Tags

Tag actions (Create, Delete, Get, Update) apply to company tags only. Tags can’t be updated via the supplier endpoint, as they may link to multiple suppliers. When a company tag is updated/deleted, all associated suppliers are automatically updated — no separate supplier update is needed.

Operations
Operations
Operations

Request

This endpoint will return data and information about Cyber-News articles of the company.

Security
bearer
Query
limitnumber[ 1 .. 200 ]

Number of records to return in the response

Default 200
sortByArray of strings

Name of the field to sort by

sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
next_tokenstring

Token received from a previous request to obtain the next chunk of data

date_range_fromstring

A starting date for range filter in the format YYYY-MM-DD (define also 'date_range_to')

date_range_tostring

An ending date for range filter in the format YYYY-MM-DD (define also 'date_range_from')

periodstring

Specifies the time range for filtering articles. Defaults to the last 24 hours if not provided.

Enum"LAST_DAY""LAST_WEEK""LAST_MONTH""LAST_YEAR""ALL"
curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/cyber-news-articles?limit=200&sortBy=string&sortDirection=ASC&next_token=string&date_range_from=string&date_range_to=string&period=LAST_DAY' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

All found Cyber-News articles are returned.

Bodyapplication/jsonArray [
company_idstring
sourcestring
source_datestring
linkstring
tagsArray of strings
titlestring
descriptionstring
typestring
notification_tsboolean
risk_insights_event_idboolean
]
Response
application/json
[ { "company_id": "string", "source": "string", "source_date": "string", "link": "string", "tags": [ … ], "title": "string", "description": "string", "type": "string", "notification_ts": true, "risk_insights_event_id": true } ]

Get company Cyber-News articles by suppliers IDs

Request

This endpoint will return data and information about Cyber-News articles of the company by suppliers IDs.

Security
bearer
Query
limitnumber[ 1 .. 200 ]

Number of records to return in the response

Default 200
sortByArray of strings

Name of the field to sort by

sortDirectionstring

The direction of the field sort specified by sort_by

Enum"ASC""asc""1""DESC""desc""-1"
next_tokenstring

Token received from a previous request to obtain the next chunk of data

date_range_fromstring

A starting date for range filter in the format YYYY-MM-DD (define also 'date_range_to')

date_range_tostring

An ending date for range filter in the format YYYY-MM-DD (define also 'date_range_from')

periodstring

Specifies the time range for filtering articles. Defaults to the last 24 hours if not provided.

Enum"LAST_DAY""LAST_WEEK""LAST_MONTH""LAST_YEAR""ALL"
supplier_idsArray of strings

Specifies the required suppliers IDs for Cyber News articles.

curl -i -X GET \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/cyber-news-articles/suppliers?limit=200&sortBy=string&sortDirection=ASC&next_token=string&date_range_from=string&date_range_to=string&period=LAST_DAY&supplier_ids=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

All found Cyber-News articles are returned.

Bodyapplication/jsonArray [
company_idstring
sourcestring
source_datestring
linkstring
tagsArray of strings
titlestring
descriptionstring
typestring
notification_tsboolean
risk_insights_event_idboolean
]
Response
application/json
[ { "company_id": "string", "source": "string", "source_date": "string", "link": "string", "tags": [ … ], "title": "string", "description": "string", "type": "string", "notification_ts": true, "risk_insights_event_id": true } ]
Operations
Operations

Webhooks Intro

The hook api provides a simple way of registering to events that happen with your suppliers

Getting Started

The following steps will walk you through the process of registering and reacting to webhooks.

  1. Register an API token

If you don’t already have an API token, you can generate one through Panorays platform or contact Panorays Support at support@panorays.com.

  1. Register your app

Before you can start receiving events, register your application with Panorays using the Handshake API call.

  1. Subscribe to relevant events

You will only receive event calls for events you subscribe to using the Subscribe API call.
Note: You can unsubscribe at any time using the Unsubscribe API call.

  1. Start receiving events

You're done! From now on, you will receive notifications for every event you subscribed to.

To learn how to secure your app and ensure you handle events only from Panorays, read about Verifying requests.

Verify Requests

Panorays signs every request with a secret that's unique to your service account, using this secret you can verify that the incoming request arrived from Panorays servers.

Operations
Operations