Skip to content

Commit ea08d04

Browse files
authored
Merge pull request #3828 from segmentio/tlalfano-patch-1
Update index.md file for the HTTP API section
2 parents fa8768c + 622cc91 commit ea08d04

File tree

1 file changed

+3
-1
lines changed
  • src/connections/sources/catalog/libraries/server/http-api

1 file changed

+3
-1
lines changed

src/connections/sources/catalog/libraries/server/http-api/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ Segment has native [sources](/docs/connections/sources/) for most use cases (lik
1414
Authenticate to the Tracking API by sending your project's **Write Key** along with a request.
1515
Authentication uses HTTP Basic Auth, which involves a `username:password` that is base64 encoded and prepended with the string `Basic`.
1616

17-
In practice that means taking a Segment source **Write Key**,`'abc123'`, as the username, adding a colon, and then the password field is left empty. After base64 encoding `'abc123'` becomes `'YWJjMTIz'`; and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIz'`.
17+
In practice that means taking a Segment source **Write Key**,`'abc123'`, as the username, adding a colon, and then the password field is left empty. After base64 encoding `'abc123:'` becomes `'YWJjMTIzOg=='`; and this is passed in the authorization header like so: `'Authorization: Basic YWJjMTIzOg=='`.
18+
19+
**Note:** Encoding the write key without a colon may work due to backward compatibility, but this may not always be the case, so it's important to include the colon before encoding.
1820

1921
### Content-Type
2022

0 commit comments

Comments
 (0)