Skip to content
/
Post segment questionnair...

papi (2)

Panorays Public API

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Support
support@panorays.com
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

Segment

Operations

Posture

Operations

Portfolio

Operations

Asset

Operations

Finding

Operations

RemediationTasks

Operations

BusinessInformation

Operations

File

Operations

Questionnaire

Operations

Post questionnaire

Request

This endpoint will send questionnaire to supplier.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

templateIdstring

name of the template to use for the questionnaire. Needs to be provided for sending a questionnaire. I's called "templateId" to not confuse the users with "display_name"

Bodyapplication/jsonrequired
pocsArray of strings(email)required
template_idstring

name of the template to use for the questionnaire. If not provided the latest template will be sent. For information regarding which template is the latest one, please contact Panorays Support.

notestring

note from the evaluator to the supplier, that will be sent with the questionnaire

ttlstring(date-time)

ttl is the due date specified by the the evaluator

questionnaire_typestring

Questionnaire type - internal/external

Default "external"
Enum"external""internal""both"
curl -i -X POST \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/questionnaires/{templateId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pocs": [
      "user@example.com"
    ],
    "template_id": "string",
    "note": "string",
    "ttl": "2019-08-24T14:15:22Z",
    "questionnaire_type": "external"
  }'

Responses

Questionnaire.

Bodyapplication/json
ttlstring or nullrequired
idobjectrequired
insert_tsstring(date-time)required
pocsArray of objectsrequired
statusstringrequired
template_idstringrequired
template_namestringrequired
Response
application/json
{
  "ttl": "string",
  "id": {},
  "insert_ts": "2019-08-24T14:15:22Z",
  "pocs": [
    {}
  ],
  "status": "string",
  "template_id": "string",
  "template_name": "string"
}

Post segment questionnaire

Request

This endpoint will send questionnaire to segment.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

templateIdstring

name of the template to use for the questionnaire. Needs to be provided for sending a questionnaire. I's called "templateId" to not confuse the users with "display_name"

segmentIdstringrequired

Id of the segment

Bodyapplication/jsonrequired
pocsArray of strings(email)required
template_idstring

name of the template to use for the questionnaire. If not provided the latest template will be sent. For information regarding which template is the latest one, please contact Panorays Support.

notestring

note from the evaluator to the supplier, that will be sent with the questionnaire

ttlstring(date-time)

ttl is the due date specified by the the evaluator

questionnaire_typestring

Questionnaire type - internal/external

Default "external"
Enum"external""internal""both"
curl -i -X POST \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/segment/{segmentId}/questionnaires/{templateId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pocs": [
      "user@example.com"
    ],
    "template_id": "string",
    "note": "string",
    "ttl": "2019-08-24T14:15:22Z",
    "questionnaire_type": "external"
  }'

Responses

Questionnaire.

Bodyapplication/json
ttlstring or nullrequired
idobjectrequired
insert_tsstring(date-time)required
pocsArray of objectsrequired
statusstringrequired
template_idstringrequired
template_namestringrequired
Response
application/json
{
  "ttl": "string",
  "id": {},
  "insert_ts": "2019-08-24T14:15:22Z",
  "pocs": [
    {}
  ],
  "status": "string",
  "template_id": "string",
  "template_name": "string"
}

Answer supplier questionnaire

Request

This endpoint will submit answers for a supplier questionnaire.

Security
bearer
Path
supplierIdstringrequired

Id of the supplier

questionnaireIdstringrequired

Id of the questionnaire

Bodyapplication/jsonrequired
answersobject

Map of question IDs to their answers

isSubmitobject

Whether to submit the questionnaire after saving answers. If true, the questionnaire will be marked as complete.

Default false
curl -i -X PUT \
  'https://panorays-papi-v2-documentation.redocly.app/_mock/swagger/v2/suppliers/{supplierId}/questionnaires/{questionnaireId}/answer' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "answers": {
      "property1": {
        "answer": "string",
        "comment": "string"
      },
      "property2": {
        "answer": "string",
        "comment": "string"
      }
    },
    "isSubmit": false
  }'

Responses

Questionnaire answers submitted successfully.

RiskInsights

Operations

BusinessSnapshot

Operations

Relationship

Operations

Licenses

Operations

Templates

Operations

Activity Center

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

Factors

Operations

CyberNewsArticles

Operations

DarkWebMentions

Operations

ReEvaluation

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.

Handshake

Operations

Subscription

Operations