Miri SDK & API Documentation for Developers

The following outlines the content of the documentation.

Introduction

There are two main building blocks for integrating Miri with your application:

1. Miri Component SDK - connects to the Miri API directly from the client and provides plug-and-play along with more modular components to integrate Miri features.
2. Miri API - most integration requirements can be satisfied using code that executes on the client. However, some code may need to be executed server-side for safety and security, depending on your integration needs. This API provides endpoints for communicating directly with Miri's public API using your unique API_KEY.

Platform Capabilities

Currently Miri supports integration with React Native mobile applications using the Miri React Native SDK. More SDKs, such as Swift and Android are on the roadmap.

Content

1. Basics / Introduction

• Overview

2. Setup and Installation

• Register for API key
• Prerequisites
• Installation

3. Basic Usage

• Add Context Provider to your app
• Initialize SDK

4. Core UI Functionality

• UI Components
• Chat: How to embed the chat UI component in a screen.
  • Welcome / Activation Interface
  • Meal-logging (support for logging meals with text or photos)
  • Figure it Out - Recipes
  • Figure it Out - Cravings
  • Figure it Out - Restaurants / Menu
  • Activity Tracker [coming soon]
  • Coach Check-ins [coming soon]
• Goals & Tracking: How to embed tracking-related UI components, such as progress against goals or meals logged.
  • Meals: Instructions for adding an interface for viewing / editing meal details. Meals are a type of Miri Artifact.
  • Progress Summary: How to display goal-related summary data to users.
• Measurements: How to embed measurement tracking UI, such as weight, or waist circumference.
• Admin: How to embed an admin-facing UI. This is user management, program creation and management.

5. Webhooks

• Webhooks
• Events
• Configuration
• Error handling