{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"API collections","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-collections","__idx":0},"children":["API collections"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An API client collection is available for testing and exploring the Namirial Notify APIs. The collection includes ready-to-use request definitions, environment configurations, and saved response examples for EviSMS, EviMail, and EviNotice."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["EviPost"]}," is not currently included in the collection. Requests can be tested manually using the examples in the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The collection is provided in ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://www.usebruno.com/"},"children":["Bruno"]}," format. Bruno is an open-source API client similar to Postman. The collection can also be imported into Postman and other compatible tools."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"collection-structure","__idx":1},"children":["Collection structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The collection is organised by service, with each service containing its Submit and Query operations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Collection root\n├── EviSMS/\n│   ├── EviSMS Submit/\n│   │   ├── EviSMS Submit.yml          (full request with variables)\n│   │   └── EviSMS Submit (simple).yml (inline values, minimal options)\n│   └── EviSMS Query/\n│       └── EviSMS Query.yml           (GET with query parameters)\n├── EviMail/\n│   ├── EviMail Submit/\n│   │   ├── EviMail Submit.yml         (full request with variables)\n│   │   └── EviMail Submit (simple).yml(inline values, minimal options)\n│   └── EviMail Query/\n│       └── EviMail Query.yml          (GET with query parameters)\n├── EviNotice/\n│   ├── EviNotice Submit/\n│   │   ├── EviNotice Submit.yml                 (full request with variables)\n│   │   ├── to email (Standard - simple).yml     (Standard_EU, minimal options)\n│   │   ├── to email (Advanced - simple).yml     (Advanced_EU, minimal options)\n│   │   ├── to email (Advanced - complete).yml   (Advanced_EU, all options)\n│   │   ├── to mobile (Standard - simple).yml    (SMS notification channel)\n│   │   └── to mobile (Standard - complete).yml  (SMS with full configuration)\n│   ├── EviNotice Query.yml            (POST with request body)\n│   ├── EviNotice GET.yml              (GET single by ID)\n│   ├── EviNotice GET Affidavits.yml   (GET affidavits)\n│   └── EviNotice GET Attachments.yml  (GET attachments as ZIP)\n└── environments/\n    ├── EviSMS.yml\n    ├── EviMail.yml\n    └── EviNotice.yml\n"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":2},"children":["Environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each service has its own environment file with pre-configured variables. Before running any request, select the environment matching the service you want to test."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The environment files define variables for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Credentials"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["User"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Password"]}," for Basic authentication. These must be replaced with your own account credentials before use."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Base URL"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["baseUrl"]}," points to the target environment. By default, the environments use the pre-production server (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["api.ecertia.com"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recipient details"]}," — test values for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_email"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_mobileNumber"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_displayName"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["recipient_legalName"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Issuer details"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["issuer_legalName"]}," and related fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message content"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subject"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Body"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},", and other request-specific fields."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certification options"]}," — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certificationLevel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TTL"]}," (time to live in minutes), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["affidavit_Kinds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Attachment data"]}," — base64-encoded sample attachment data for services that support attachments."]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The environment files may contain sample credentials. Replace all authentication values with your own credentials before running requests against any environment."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"runtime-scripts","__idx":3},"children":["Runtime scripts"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The collection includes runtime scripts that automate common tasks during testing:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Before-request scripts"]}," automatically increment the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}," variable before each submit request. This ensures each test submission gets a unique lookup key without manual intervention."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["After-response scripts"]}," capture the returned ID from submit responses and store it in an environment variable (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]}," for EviSMS and EviMail, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Id"]}," for EviNotice). This makes the ID immediately available for follow-up query or get requests in the same session."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"saved-response-examples","__idx":4},"children":["Saved response examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Most requests in the collection include one or more saved response examples showing real responses from the pre-production environment. These examples include full response headers and JSON bodies."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The saved examples cover common scenarios such as successful submissions (HTTP 200 with a returned ID), successful queries with matching results, and queries with no matches."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-to-use-the-collection","__idx":5},"children":["How to use the collection"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"with-bruno","__idx":6},"children":["With Bruno"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Download or clone the collection folder."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open Bruno and select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open Collection"]},", then point to the collection root folder."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Select the environment matching the service you want to test (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EviSMS"]},")."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["User"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Password"]}," variables in the environment with your credentials."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Open a request and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"with-postman","__idx":7},"children":["With Postman"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Postman, select ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Import"]}," and choose the collection folder or individual ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".yml"]}," files."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Postman will convert the Bruno format on import."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Create a Postman environment with the same variable names defined in the Bruno environment files."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Replace credentials and base URL as needed."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":8},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}]}]}]},"headings":[{"value":"API collections","id":"api-collections","depth":1},{"value":"Collection structure","id":"collection-structure","depth":2},{"value":"Environments","id":"environments","depth":2},{"value":"Runtime scripts","id":"runtime-scripts","depth":2},{"value":"Saved response examples","id":"saved-response-examples","depth":2},{"value":"How to use the collection","id":"how-to-use-the-collection","depth":2},{"value":"With Bruno","id":"with-bruno","depth":3},{"value":"With Postman","id":"with-postman","depth":3},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"API collections","description":"API client collections for testing and exploring the Namirial Notify APIs with Bruno or Postman.","layout":"doc","outline":"deep","keywords":["bruno collection","postman collection","api testing","api examples","namirial notify api","evinotice examples","evimail examples","evisms examples"],"seo":{"title":"API collections"}},"lastModified":"2026-07-28T10:32:13.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/dev/postman-collections","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}