Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-874 #37

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

DOCS-874 #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
196 changes: 0 additions & 196 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1411,202 +1411,6 @@ ___
deepview_android: "the current deepview selected for the Android platform",
}
```

___

## Creating a New Branch App Config

#### Endpoint

```js
POST /v1/app
Content-Type: application/json
```

#### Parameters

**user_id** _required_
: The dashboard user id. Can be found on your [Branch Dashboard](https://dashboard.branch.io/settings/account)

**app_name** _required_ (max 255 characters)
: The name of the app.

**dev_name** _required_ (max 255 characters)
: The main contact developer name.

**dev_email** _required_ (max 255 characters)
: The main contact developer email.

Note: we'll send an invite message to this email upon account creation.

**android_app** _optional_
: Whether an Android app is enabled, (0 or 1 indicating present)

**android_url** _optional_
: The url of the Android store, or package name (com.android.myapp). `android_app` must be set to `2`.

**android_uri_scheme** _optional_
: The Android URI scheme.

**android_package_name** _optional_
: The Android package name (com.android.myapp)

**sha256_cert_fingerprints** _optional_
: The SHA256 fingerprints for App Links, in array form

**android_app_links_enabled** _optional_
: Whether App Links are enabled, (0 or 1 indicating true)

**ios_app** _optional_
: Whether an iOS app is enabled, (0 or 1 indicating present)

**ios_url** _optional_
: The url of iOS store, or app id (id512451233), or a fallback URL for iOS if present. `ios_app` must be set to `2`.

**ios_uri_scheme** _optional_
: The iOS URI scheme.

**ios_store_country** _optional_ (max 255 characters)
: The country code of the app, default to 'US'.

**ios_bundle_id** _optional_
: The iOS bundle ID

**ios_team_id** _optional_
: The iOS Team ID

**universal_linking_enabled** _optional_
: Whether Universal Links should be enabled, (0 or 1 indicating true)

**fire_url** _optional_
: The redirect on Fire phones

**windows_phone_url** _optional_
: The redirect on Windows phones

**blackberry_url** _optional_
: The redirect on Blackberry phones

**web_url** _optional_
: Backup website if URLs are null.

**default_desktop_url** _optional_
: The default desktop redirect, or null if set to hosted SMS

**text_message** _optional_ (max 255 characters)
: Text message to use for text-me feature, {{ link }} will be replaced with short link.

**og_app_id** _optional_ (max 255 characters)
: Default Open Graph (OG) app id.

**og_title** _optional_ (max 255 characters)
: Default OG title to be used with links.

**og_description** _optional_ (max 255 characters)
: Default OG description to be used with links.

**og_image_url** _optional_ (max 255 characters)
: Default OG image URL to be used with links.

**deepview_desktop** _optional_
: The current deepview selected for the desktop platform, (eg "default", "my_template")

**deepview_ios** _optional_
: The current deepview selected for the iOS platform, (eg "default", "my_template")

**deepview_android** _optional_
: The current deepview selected for the Android platform, (eg "default", "my_template")

#### Request

```bash
curl -XPOST -d '{
"user_id": "...",
"app_name": "eneff_test_3",
"dev_name": "...",
"dev_email": "...",

"always_open_app": "1",

"android_app": "2",
"android_url": "https://www.example.com/ios",
"android_uri_scheme": "branchtest://",
"android_package_name": "com.branch.test",
"android_app_links_enabled": "1",
"sha256_cert_fingerprints": ["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"],

"ios_app": "2",
"ios_url": "https://www.example.com/ios",
"ios_uri_scheme": "branchtest://",
"ios_store_country": "US",
"universal_linking_enabled": "1",
"ios_bundle_id": "com.branch.test",
"ios_team_id": "PW4Q8885U7",

"fire_url": "https://www.example.com/amazon",
"windows_phone_url": "https://www.example.com/windows",
"blackberry_url": "https://www.example.com/blackberry",
"web_url": "https://www.example.com/web",

"default_desktop_url": "https://www.example.com/desktop",
"text_message": "click here to download",

"og_app_id": "branch 123",
"og_title": "branch test",
"og_description": "branch description",
"og_image_url": "http://lorempixel.com/400/400/",

"deepview_desktop": "branch_default",
"deepview_ios": "branch_default",
"deepview_android": "branch_default"
}' 'https://api.branch.io/v1/app'
```

#### Response

```bash
{
"id": "...",
"app_key": "...",
"creation_date": "2016-12-01T19:38:25.661Z",
"app_name": "eneff_test_3",
"origin": ...",
"dev_name": "...",
"dev_email": "...",
"always_open_app": "1",
"android_app": "2",
"android_url": "https://www.example.com/ios",
"android_uri_scheme": "branchtest://",
"android_package_name": "com.branch.test",
"android_app_links_enabled": "1",
"ios_app": "2",
"ios_url": "https://www.example.com/ios",
"ios_uri_scheme": "branchtest://",
"ios_store_country": "US",
"ios_bundle_id": "com.branch.test",
"ios_team_id": "PW4Q8885U7",
"universal_linking_enabled": "1",
"fire_url": "https://www.example.com/amazon",
"windows_phone_url": "https://www.example.com/windows",
"blackberry_url": "https://www.example.com/blackberry",
"web_url": "https://www.example.com/web",
"default_desktop_url": "https://www.example.com/desktop",
"short_url_domain": "",
"default_short_url_domain": "94h3.app.link",
"alternate_short_url_domain": "94h3-alternate.app.link",
"text_message": "click here to download",
"og_app_id": "branch 123",
"og_title": "branch test",
"og_image_url": "http://lorempixel.com/400/400/",
"og_description": "branch description",
"branch_key": "...",
"branch_secret": "...",
"deepview_desktop": "branch_default",
"deepview_ios": "branch_default",
"deepview_android": "branch_default"
}
```

___

## Updating a Branch App Config
Expand Down