@nomad-media/public 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +62 -0
- package/dist/nomad-media-sdk-debug.js +1702 -0
- package/dist/nomad-media-sdk.min.js +25 -0
- package/package.json +16 -0
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Nomad Media Public
|
|
2
|
+
This package contains the public version of the Nomad Media SDK. It includes all of the media methods of the SDK.
|
|
3
|
+
|
|
4
|
+
## Minimum Requirements
|
|
5
|
+
- Node.js 12.0.0
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
To use the Nomad SDK, download the npm nomad-media-npm.
|
|
9
|
+
|
|
10
|
+
```shell
|
|
11
|
+
npm install @nomad-media/public
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Then to import it, you can either use the default version, or the debug version. The difference is that the debug version isn't compressed and has more documentation and named parameters.
|
|
15
|
+
|
|
16
|
+
To use the default version use:
|
|
17
|
+
|
|
18
|
+
```javascript
|
|
19
|
+
import NomadMediaSDK from "@nomad-media/public";
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
To use the debug version user:
|
|
23
|
+
|
|
24
|
+
```javascript
|
|
25
|
+
import NomadMediaSDK from "@nomad-media/public/debug";
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
To initialize the sdk, call the NomadMediaSDK class as shown below:
|
|
29
|
+
|
|
30
|
+
```javascript
|
|
31
|
+
const SDK = NomadMediaSDK(config);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Configure Environmental Variables
|
|
35
|
+
|
|
36
|
+
Follow this format for the config:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
const config = {
|
|
40
|
+
"username": "username",
|
|
41
|
+
"password": "password",
|
|
42
|
+
"serviceApiUrl": "serverApiUrl",
|
|
43
|
+
"apiType": "admin",
|
|
44
|
+
"debugMode": true
|
|
45
|
+
};
|
|
46
|
+
```
|
|
47
|
+
serviceApiUrl: Specifies the url of the server you are trying to connect to.
|
|
48
|
+
|
|
49
|
+
apiType: Specifies whether the function you are trying to run is **admin** or **portal**.
|
|
50
|
+
|
|
51
|
+
debugMode: Specifies when running functions, whether of not to print api call information.
|
|
52
|
+
|
|
53
|
+
You are now ready to use the SDK in your project.
|
|
54
|
+
|
|
55
|
+
> 📘 Contact: Make sure to contact Nomad Media support to get username, password, and url for your enviromnent.
|
|
56
|
+
|
|
57
|
+
> 🚧 Make sure to keep your configuration options secret and do not share them publicly.
|
|
58
|
+
|
|
59
|
+
## Nomad SDK Documentation
|
|
60
|
+
|
|
61
|
+
- [Nomad SDK Modules](https://developer.nomad-cms.com/docs/nomad-api-modules)
|
|
62
|
+
- [Nomad SDK NPM Samples](https://github.com/Nomad-Media/samples-js)
|