Skip to content

Commit 2f98f7d

Browse files
author
Inbal Tako
committed
Update readme
1 parent 18128d3 commit 2f98f7d

1 file changed

Lines changed: 66 additions & 1 deletion

File tree

README.md

Lines changed: 66 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ To get your *API KEY*, login to your SecureNative account and go to project sett
3737

3838
### Option 1: Initialize via ConfigurationBuilder
3939
```php
40+
require_once __DIR__ . '/vendor/autoload.php';
41+
42+
use SecureNative\sdk\SecureNative;
43+
use SecureNative\sdk\SecureNativeOptions;
44+
4045
$options = new SecureNativeOptions();
4146

4247
$options->setMaxEvents(10);
@@ -47,15 +52,56 @@ SecureNative::init("YOUR_API_KEY", $options);
4752
### Option 2: Initialize via API Key
4853

4954
```php
50-
SecureNative::init("YOUR_API_KEY", $options);
55+
require_once __DIR__ . '/vendor/autoload.php';
56+
57+
use SecureNative\sdk\SecureNative;
58+
59+
60+
SecureNative::init("YOUR_API_KEY");
5161
```
5262

5363
## Tracking events
5464

5565
Once the SDK has been initialized, tracking requests sent through the SDK
5666
instance.
5767

68+
```php
69+
require_once __DIR__ . '/vendor/autoload.php';
70+
71+
use SecureNative\sdk\SecureNative;
72+
use SecureNative\sdk\SecureNativeOptions;
73+
use SecureNative\sdk\EventTypes;
74+
use SecureNative\sdk\SecureNativeContext;
75+
76+
77+
$token = "[SECURED_CLIENT_TOKEN]";
78+
$ctx = new SecureNativeContext($token, "79.179.88.157", null, (object)["user-agent" => "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us"], null, null, null);
79+
80+
SecureNative::track(array(
81+
'event' => EventTypes::LOG_IN,
82+
'context' => ctx,
83+
'userId' => '1234',
84+
'userTraits' => (object)[
85+
'name' => 'Your Name',
86+
'email' => 'name@gmail.com'
87+
],
88+
// Custom properties
89+
'properties' => (object)[
90+
"prop1" => "CUSTOM_PARAM_VALUE",
91+
"prop2" => true,
92+
"prop3" => 3
93+
]
94+
));
95+
```
96+
5897
```php
98+
require_once __DIR__ . '/vendor/autoload.php';
99+
100+
use SecureNative\sdk\SecureNative;
101+
use SecureNative\sdk\EventTypes;
102+
use SecureNative\sdk\SecureNativeContext;
103+
104+
59105
SecureNative::track(array(
60106
'event' => EventTypes::LOG_IN,
61107
'context' => SecureNative::contextFromContext(),
@@ -76,6 +122,13 @@ SecureNative::track(array(
76122
You can also create request context from request:
77123

78124
```php
125+
require_once __DIR__ . '/vendor/autoload.php';
126+
127+
use SecureNative\sdk\SecureNative;
128+
use SecureNative\sdk\EventTypes;
129+
use SecureNative\sdk\SecureNativeContext;
130+
131+
79132
SecureNative::track(array(
80133
'event' => EventTypes::LOG_IN,
81134
'context' => SecureNativeContext::fromRequest(),
@@ -92,6 +145,13 @@ SecureNative::track(array(
92145
**Example**
93146

94147
```php
148+
require_once __DIR__ . '/vendor/autoload.php';
149+
150+
use SecureNative\sdk\SecureNative;
151+
use SecureNative\sdk\EventTypes;
152+
use SecureNative\sdk\SecureNativeContext;
153+
154+
95155
$ver = SecureNative::verify(array(
96156
'event' => EventTypes::LOG_IN,
97157
'userId' => '27',
@@ -108,6 +168,11 @@ $ver = SecureNative::verify(array(
108168
Apply our filter to verify the request is from us, for example:
109169

110170
```php
171+
require_once __DIR__ . '/vendor/autoload.php';
172+
173+
use SecureNative\sdk\SecureNative;
174+
175+
111176
$verified = SecureNative::getMiddleware()->verifySignature();
112177

113178
if ($verified) {

0 commit comments

Comments
 (0)