Skip to content

Commit da55e9b

Browse files
update references
1 parent 126f37c commit da55e9b

File tree

4 files changed

+18
-19
lines changed

4 files changed

+18
-19
lines changed

‎Postman Collection/FidelAPI Test.postman_collection.json‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"info": {
33
"_postman_id": "d42cd46c-0f92-438b-9e1d-953dbcb4999f",
4-
"name": "FidelAPI Test",
4+
"name": "NodeJS API Test",
55
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
66
},
77
"item": [
@@ -15,7 +15,7 @@
1515
"header": [
1616
{
1717
"key": "x-api-key",
18-
"value": "{{FIDELTEST-API-KEY}}",
18+
"value": "{{API-KEY}}",
1919
"type": "text"
2020
}
2121
],
@@ -39,7 +39,7 @@
3939
"header": [
4040
{
4141
"key": "x-api-key",
42-
"value": "{{FIDELTEST-API-KEY}}",
42+
"value": "{{API-KEY}}",
4343
"type": "text"
4444
}
4545
],
@@ -64,7 +64,7 @@
6464
"header": [
6565
{
6666
"key": "x-api-key",
67-
"value": "{{FIDELTEST-API-KEY}}",
67+
"value": "{{API-KEY}}",
6868
"type": "text"
6969
}
7070
],
@@ -102,7 +102,7 @@
102102
"header": [
103103
{
104104
"key": "x-api-key",
105-
"value": "{{FIDELTEST-API-KEY}}",
105+
"value": "{{API-KEY}}",
106106
"type": "text"
107107
}
108108
],
@@ -126,7 +126,7 @@
126126
"header": [
127127
{
128128
"key": "x-api-key",
129-
"value": "{{FIDELTEST-API-KEY}}",
129+
"value": "{{API-KEY}}",
130130
"type": "text"
131131
}
132132
],
@@ -151,7 +151,7 @@
151151
"header": [
152152
{
153153
"key": "x-api-key",
154-
"value": "{{FIDELTEST-API-KEY}}",
154+
"value": "{{API-KEY}}",
155155
"type": "text"
156156
}
157157
],
@@ -189,7 +189,7 @@
189189
"header": [
190190
{
191191
"key": "x-api-key",
192-
"value": "{{FIDELTEST-API-KEY}}",
192+
"value": "{{API-KEY}}",
193193
"type": "text"
194194
}
195195
],
@@ -213,7 +213,7 @@
213213
"header": [
214214
{
215215
"key": "x-api-key",
216-
"value": "{{FIDELTEST-API-KEY}}",
216+
"value": "{{API-KEY}}",
217217
"type": "text"
218218
}
219219
],
@@ -238,7 +238,7 @@
238238
"header": [
239239
{
240240
"key": "x-api-key",
241-
"value": "{{FIDELTEST-API-KEY}}",
241+
"value": "{{API-KEY}}",
242242
"type": "text"
243243
}
244244
],
@@ -273,7 +273,7 @@
273273
"header": [
274274
{
275275
"key": "x-api-key",
276-
"value": "{{FIDELTEST-API-KEY}}",
276+
"value": "{{API-KEY}}",
277277
"type": "text"
278278
},
279279
{
@@ -306,7 +306,7 @@
306306
"header": [
307307
{
308308
"key": "x-api-key",
309-
"value": "{{FIDELTEST-API-KEY}}",
309+
"value": "{{API-KEY}}",
310310
"type": "text"
311311
},
312312
{

‎Postman Collection/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### Fidel API Test - Postman Collection
1+
### NodeJS Lambda API - Postman Collection
22

33
---
44

@@ -10,8 +10,8 @@ Im sharing the endpoint collection that i used through development, i hope it wi
1010

1111
Theres some ENV keys to make things easier, you can store them as a environment postman variable, or just overwrite with the expected value
1212

13-
**`{{AWS-API-URL}}`** - The URL of our API Gateway, from AWS, for example, on my usage: **https://6pkqjlxvu0.execute-api.us-east-1.amazonaws.com**
13+
**`{{AWS-API-URL}}`** - The URL of our API Gateway, from AWS, for example: **https://bla.execute-api.us-east-1.amazonaws.com**
1414

15-
**`{{FIDELTEST-API-KEY}}`** - Is the API Key to protect our API, is available on `serverless.yml` file, but you just can fill it with **`v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH`**
15+
**`{{API-KEY}}`** - Is the API Key to protect our API, is available on `serverless.yml` file, but you just can fill it with **`v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH`**
1616

1717
**`brandId, locationId, offerId`** - Its the ID/UUID of current subject (Offer, Location or Brand)

‎README.md‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,9 @@ npm run test
4242
---
4343

4444
### Informations
45-
- The project is protected under an API KEY setted on **serverless.yml** file, that are **fideltest-key**. That was based on the same protection used on FidelAPI (Reference: https://reference.fidel.uk/reference#authentication), **fideltest-key** is supposed to be a unique key wranted for the customers of the application.
45+
- The project is protected under an API KEY setted on **serverless.yml** file, that are **api-key**. This **api-key** is supposed to be a unique key wranted for the customers of the application.
4646
Because of that API KEY, you must add the header **`x-api-key`** with value **`v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH`** in all the requests that you would do to the API.
4747
- I shared my [Postman Collection](https://github.com/nicolaslima321/lambda-nodejs-api/tree/master/Postman%20Collection) used to develop the application, it contains all endpoints, headers, and body properly filled, it can help to test my API.
48-
- My production API is available on https://6pkqjlxvu0.execute-api.us-east-1.amazonaws.com/dev/
4948
- To simulate that offers creations always be made by the same publisher, i created an environment variable called DEFAULT_UUID, with an static UUID
5049
- I also created some endpoints that allow creation of offers, brands and locations
5150

@@ -54,7 +53,7 @@ The endpoints that have **{offerId}**, **{locationId}**, **{brandId}**, needs to
5453

5554
- API Keys:
5655
```
57-
fideltest-key (x-api-key): v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH
56+
api-key (x-api-key): v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH
5857
```
5958

6059
- Brands

‎serverless.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ provider:
66
name: aws
77
apiGateway:
88
apiKeys:
9-
- name: fideltest-key
9+
- name: api-key
1010
value: v3IPj3dPvT62rJYm3Ho7d2owPMxyYQ7x5kJNWcsH
1111
runtime: nodejs12.x
1212
lambdaHashingVersion: 20201221

0 commit comments

Comments
 (0)