{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Development and integration guides","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":"development-and-integration-guides","__idx":0},"children":["Development and integration guides"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Resources for integrating with Namirial Notify programmatically or through a supported no-code integration path."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"rest-apis","__idx":1},"children":["REST APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Namirial Notify exposes REST APIs for certified communication services. You can"," ","use these APIs to submit communications, query their status, and retrieve"," ","related evidence from your own systems."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}," for authentication,"," ","environments, service guides, and the unified OpenAPI reference."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-handling","__idx":2},"children":["Error handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the shared ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]}," guide for HTTP status codes,"," ","service-specific error payload formats, and production recommendations for"," ","client-side error processing."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callbacks-and-webhooks","__idx":3},"children":["Callbacks and webhooks"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Namirial Notify can send push notifications to your system when a transaction changes state. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}," for configuration details."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-workflows","__idx":4},"children":["Integration workflows"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}," for end-to-end patterns"," ","that combine Submit, callback handling, Query or Get reconciliation, and"," ","affidavit retrieval."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"security-and-authentication","__idx":5},"children":["Security and authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]}," for production"," ","guidance on credential handling, callback hardening, and data-minimization"," ","practices."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"performance-and-scaling","__idx":6},"children":["Performance and scaling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/performance-guidelines"},"children":["Performance and scaling"]}," for guidance on"," ","callbacks versus polling, pagination, evidence retrieval, and high-volume usage"," ","planning."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-collections","__idx":7},"children":["API collections"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Ready-to-use API client collections are available for testing and exploring the APIs. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/postman-collections"},"children":["API collections"]}," for download links and setup instructions."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"qerds-user-registration","__idx":8},"children":["QERDS user registration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The QERDS identity verification service exposes a separate API for pre-registering recipients before sending a QERDS EviNotice. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/qerds-registration"},"children":["QERDS user registration API"]}," for the endpoint, request fields, response schema, and return URL error codes."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"communication-templates","__idx":9},"children":["Communication templates"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Custom email templates created in the admin UI can be referenced in API submissions to replace the default system emails. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/templates"},"children":["Using communication templates from the API"]}," for the EviNotice template parameters and examples."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"no-code-integration","__idx":10},"children":["No-code integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you prefer to integrate without writing code, Namirial Notify supports integration through certifica.me. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/no-code-certificame"},"children":["No-code integration"]}," for details."]}]},"headings":[{"value":"Development and integration guides","id":"development-and-integration-guides","depth":1},{"value":"REST APIs","id":"rest-apis","depth":2},{"value":"Error handling","id":"error-handling","depth":2},{"value":"Callbacks and webhooks","id":"callbacks-and-webhooks","depth":2},{"value":"Integration workflows","id":"integration-workflows","depth":2},{"value":"Security and authentication","id":"security-and-authentication","depth":2},{"value":"Performance and scaling","id":"performance-and-scaling","depth":2},{"value":"API collections","id":"api-collections","depth":2},{"value":"QERDS user registration","id":"qerds-user-registration","depth":2},{"value":"Communication templates","id":"communication-templates","depth":2},{"value":"No-code integration","id":"no-code-integration","depth":2}],"frontmatter":{"title":"Development and integration guides","description":"Overview of the development and integration resources available for Namirial Notify, including REST APIs, callbacks, error handling, security guidance, and API collections.","layout":"doc","outline":"deep","keywords":["namirial notify integration","api integration","rest api","callbacks","webhooks","postman","no-code","developer guide"],"seo":{"title":"Development and integration guides"}},"lastModified":"2026-06-23T15:38:17.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/dev","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}